TSingleReferencedObject< T > Class Template Reference

a singulater reference counted object that gets destroyed when the refount goes to zero More...

#include <mia/core/singular_refobj.hh>

Collaboration diagram for TSingleReferencedObject< T >:
[legend]

Data Structures

struct  Destructor
 
struct  EmptyDestructor
 

Public Member Functions

unsigned get_refcount () const
 
 operator T () const
 
TSingleReferencedObjectoperator= (const TSingleReferencedObject< T > &other)
 
TSingleReferencedObjectoperator= (TSingleReferencedObject< T > &&other)
 
 TSingleReferencedObject ()
 
 TSingleReferencedObject (T data, const Destructor &d=empty_destructor)
 
 TSingleReferencedObject (const TSingleReferencedObject< T > &other)
 
 TSingleReferencedObject (TSingleReferencedObject< T > &&other)
 
 ~TSingleReferencedObject ()
 

Static Public Attributes

static const EmptyDestructor empty_destructor
 

Detailed Description

template<typename T>
class TSingleReferencedObject< T >

a singulater reference counted object that gets destroyed when the refount goes to zero

This template handles singular objects that must no be copied (e.g. a resource) but that do also not fit the sigleton pattern. An example use are the HDF5 file, group, and dataset handles.

Template Parameters
Ttype of the data to be hold
Dtype of a functor that frees the resource. It must provide a static method static void apply(T& data) that frees the resource.

Definition at line 47 of file singular_refobj.hh.

Constructor & Destructor Documentation

◆ TSingleReferencedObject() [1/4]

template<typename T >
TSingleReferencedObject< T >::TSingleReferencedObject ( )

Definition at line 105 of file singular_refobj.hh.

◆ TSingleReferencedObject() [2/4]

template<typename T >
TSingleReferencedObject< T >::TSingleReferencedObject ( data,
const Destructor d = empty_destructor 
)

Definition at line 111 of file singular_refobj.hh.

◆ TSingleReferencedObject() [3/4]

template<typename T >
TSingleReferencedObject< T >::TSingleReferencedObject ( const TSingleReferencedObject< T > &  other)

Definition at line 117 of file singular_refobj.hh.

◆ TSingleReferencedObject() [4/4]

template<typename T >
TSingleReferencedObject< T >::TSingleReferencedObject ( TSingleReferencedObject< T > &&  other)

Definition at line 136 of file singular_refobj.hh.

◆ ~TSingleReferencedObject()

template<typename T >
TSingleReferencedObject< T >::~TSingleReferencedObject ( )

Definition at line 156 of file singular_refobj.hh.

Member Function Documentation

◆ get_refcount()

template<typename T >
unsigned TSingleReferencedObject< T >::get_refcount ( ) const

Definition at line 170 of file singular_refobj.hh.

References NS_MIA_END.

◆ operator T()

template<typename T >
TSingleReferencedObject< T >::operator T ( ) const

Definition at line 164 of file singular_refobj.hh.

◆ operator=() [1/2]

template<typename T >
TSingleReferencedObject< T > & TSingleReferencedObject< T >::operator= ( const TSingleReferencedObject< T > &  other)

Definition at line 125 of file singular_refobj.hh.

◆ operator=() [2/2]

template<typename T >
TSingleReferencedObject< T > & TSingleReferencedObject< T >::operator= ( TSingleReferencedObject< T > &&  other)

Definition at line 143 of file singular_refobj.hh.

Field Documentation

◆ empty_destructor

template<typename T>
const TSingleReferencedObject< T >::EmptyDestructor TSingleReferencedObject< T >::empty_destructor
static

Definition at line 59 of file singular_refobj.hh.


The documentation for this class was generated from the following file: