DCMTK Version 3.6.8
OFFIS DICOM Toolkit
Public Member Functions | Private Member Functions | Private Attributes | List of all members
OFGlobal< T > Class Template Reference

Template class which allows to declare global objects that are protected by a Mutex if used in multi-thread applications. More...

Public Member Functions

 OFGlobal (const T &arg)
 constructor. More...
 
virtual ~OFGlobal ()
 destructor.
 
void set (const T &arg)
 assigns new value to this object. More...
 
void xget (T &arg)
 gets the value of this object. More...
 
get ()
 returns the value of this object. More...
 

Private Member Functions

 OFGlobal ()
 unimplemented private default constructor
 
 OFGlobal (const OFGlobal< T > &arg)
 unimplemented private copy constructor
 
const OFGlobal< T > & operator= (const OFGlobal< T > &arg)
 unimplemented private assignment operator
 

Private Attributes

val
 value of this object
 
OFMutex theMutex
 if compiled for multi-thread operation, the Mutex protecting access to the value of this object.
 

Detailed Description

template<class T>
class OFGlobal< T >

Template class which allows to declare global objects that are protected by a Mutex if used in multi-thread applications.

Must be compiled with -DWITH_THREADS for multi-thread-operation. Template class T must have copy constructor and assignment operator.

Constructor & Destructor Documentation

◆ OFGlobal()

template<class T >
OFGlobal< T >::OFGlobal ( const T &  arg)
inline

constructor.

Parameters
argvalue to which this object is initialised

Member Function Documentation

◆ get()

template<class T >
T OFGlobal< T >::get ( )
inline

returns the value of this object.

If compiled for multi-thread operation, access to the value of the object is protected by a Mutex. The result is returned by value, not by reference.

Returns
value of this object.

References OFMutex::lock(), OFGlobal< T >::theMutex, OFMutex::unlock(), and OFGlobal< T >::val.

◆ set()

template<class T >
void OFGlobal< T >::set ( const T &  arg)
inline

assigns new value to this object.

If compiled for multi-thread operation, access to the value of the object is protected by a Mutex.

Parameters
argnew value

References OFMutex::lock(), OFGlobal< T >::theMutex, OFMutex::unlock(), and OFGlobal< T >::val.

◆ xget()

template<class T >
void OFGlobal< T >::xget ( T &  arg)
inline

gets the value of this object.

If compiled for multi-thread operation, access to the value of the object is protected by a Mutex.

Parameters
argreturn value is assigned to this parameter.

References OFMutex::lock(), OFGlobal< T >::theMutex, OFMutex::unlock(), and OFGlobal< T >::val.


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


Generated on Tue Dec 19 2023 for DCMTK Version 3.6.8 by Doxygen 1.9.4