itk::SimpleMutexLock Class Reference

#include <itkMutexLock.h>

Detailed Description

Simple mutual exclusion locking class.

SimpleMutexLock allows the locking of variables which are accessed through different threads. This header file also defines SimpleMutexLock which is not a subclass of Object.

Definition at line 48 of file itkMutexLock.h.

Public Types
typedef SimpleMutexLock	Self

Public Member Functions
void	Delete ()
MutexType &	GetMutexLock ()
MutexType	GetMutexLock () const
virtual const char *	GetNameOfClass ()
void	Lock ()
bool	TryLock ()
void	Unlock ()
	SimpleMutexLock ()
virtual	~SimpleMutexLock ()

Static Public Member Functions
static SimpleMutexLock *	New ()

Protected Attributes
MutexType	m_MutexLock

Member Typedef Documentation

typedef SimpleMutexLock itk::SimpleMutexLock::Self

Standard class typedefs.

Definition at line 52 of file itkMutexLock.h.

Constructor & Destructor Documentation

itk::SimpleMutexLock::SimpleMutexLock

(

)

Constructor and destructor left public purposely.

virtual itk::SimpleMutexLock::~SimpleMutexLock ( )

virtual

Constructor and destructor left public purposely.

Member Function Documentation

void itk::SimpleMutexLock::Delete ( )

inline

Definition at line 62 of file itkMutexLock.h.

MutexType& itk::SimpleMutexLock::GetMutexLock ( )

inline

Access the MutexType member variable from outside this class

Definition at line 79 of file itkMutexLock.h.

MutexType itk::SimpleMutexLock::GetMutexLock ( ) const

inline

Definition at line 84 of file itkMutexLock.h.

virtual const char* itk::SimpleMutexLock::GetNameOfClass ( )

inlinevirtual

Used for debugging and other run-time purposes.

Definition at line 65 of file itkMutexLock.h.

void itk::SimpleMutexLock::Lock

(

)

Lock the MutexLock.

static SimpleMutexLock* itk::SimpleMutexLock::New ( )

static

Methods for creation and destruction through the object factory.

bool itk::SimpleMutexLock::TryLock

(

)

Non-blocking Lock access.

Returns

bool - true if lock is captured, false if it was already heald by someone else.

void itk::SimpleMutexLock::Unlock

(

)

Unlock the MutexLock.

Member Data Documentation

MutexType itk::SimpleMutexLock::m_MutexLock

protected

Definition at line 90 of file itkMutexLock.h.

---

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

• itkMutexLock.h