ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::MutexLockHolder< TMutex > Class Template Reference

#include <itkMutexLockHolder.h>

Detailed Description

template<typename TMutex>
class itk::MutexLockHolder< TMutex >

A container to store a Mutex. This holder class for ensuring that locks are released in the event of an exception being thrown after the lock was created.

Definition at line 44 of file itkMutexLockHolder.h.

Public Types

typedef TMutex MutexType
 
typedef MutexLockHolder Self
 

Public Member Functions

 MutexLockHolder (MutexType &mutex, const bool noblock=false)
 
 ~MutexLockHolder ()
 
bool GetLockCaptured () const
 
 operator bool () const
 

Protected Attributes

bool m_LockCaptured
 
MutexTypem_Mutex
 

Private Member Functions

 MutexLockHolder (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Member Typedef Documentation

template<typename TMutex>
typedef TMutex itk::MutexLockHolder< TMutex >::MutexType

Definition at line 48 of file itkMutexLockHolder.h.

template<typename TMutex>
typedef MutexLockHolder itk::MutexLockHolder< TMutex >::Self

Definition at line 47 of file itkMutexLockHolder.h.

Constructor & Destructor Documentation

template<typename TMutex>
itk::MutexLockHolder< TMutex >::MutexLockHolder ( MutexType mutex,
const bool  noblock = false 
)
inline
template<typename TMutex>
itk::MutexLockHolder< TMutex >::~MutexLockHolder ( )
inline
template<typename TMutex>
itk::MutexLockHolder< TMutex >::MutexLockHolder ( const Self )
private

Member Function Documentation

template<typename TMutex>
bool itk::MutexLockHolder< TMutex >::GetLockCaptured ( ) const
inline

True if the holder has acquired the lock, for no-blocking

  • constructor this will always be true.

Definition at line 67 of file itkMutexLockHolder.h.

References itk::MutexLockHolder< TMutex >::m_LockCaptured.

template<typename TMutex>
itk::MutexLockHolder< TMutex >::operator bool ( ) const
inline

True if the holder has acquired the lock, for no-blocking

  • constructor this will always be true.

Definition at line 68 of file itkMutexLockHolder.h.

References itk::MutexLockHolder< TMutex >::m_LockCaptured.

template<typename TMutex>
void itk::MutexLockHolder< TMutex >::operator= ( const Self )
private

Member Data Documentation

template<typename TMutex>
bool itk::MutexLockHolder< TMutex >::m_LockCaptured
protected
template<typename TMutex>
MutexType& itk::MutexLockHolder< TMutex >::m_Mutex
protected

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