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
MutexType &	m_Mutex

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

Definition at line 50 of file itkMutexLockHolder.h.

References itk::MutexLockHolder< TMutex >::m_LockCaptured, and itk::MutexLockHolder< TMutex >::m_Mutex.

template<typename TMutex>

itk::MutexLockHolder< TMutex >::~MutexLockHolder ( )

inline

Definition at line 71 of file itkMutexLockHolder.h.

References itk::MutexLockHolder< TMutex >::m_LockCaptured, and itk::MutexLockHolder< TMutex >::m_Mutex.

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.

Member Data Documentation

template<typename TMutex>

bool itk::MutexLockHolder< TMutex >::m_LockCaptured

protected

Definition at line 81 of file itkMutexLockHolder.h.

Referenced by itk::MutexLockHolder< TMutex >::GetLockCaptured(), itk::MutexLockHolder< TMutex >::MutexLockHolder(), itk::MutexLockHolder< TMutex >::operator bool(), and itk::MutexLockHolder< TMutex >::~MutexLockHolder().

template<typename TMutex>

MutexType& itk::MutexLockHolder< TMutex >::m_Mutex

protected

Definition at line 80 of file itkMutexLockHolder.h.

Referenced by itk::MutexLockHolder< TMutex >::MutexLockHolder(), and itk::MutexLockHolder< TMutex >::~MutexLockHolder().

---

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

• itkMutexLockHolder.h