igtl::SimpleMutexLock Class Reference

Simple mutual exclusion locking class. More...

#include <igtlMutexLock.h>

List of all members.

Public Types
typedef SimpleMutexLock	Self
Public Member Functions
virtual const char *	GetNameOfClass ()
void	Lock (void)
void	Unlock (void)
	SimpleMutexLock ()
virtual	~SimpleMutexLock ()
MutexType &	GetMutexLock ()
const MutexType	GetMutexLock () const
Static Public Member Functions
static SimpleMutexLock *	New ()
Protected Attributes
MutexType	m_MutexLock

---

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 85 of file igtlMutexLock.h.

---

Member Typedef Documentation

typedef SimpleMutexLock igtl::SimpleMutexLock::Self

Standard class typedefs.

Definition at line 89 of file igtlMutexLock.h.

---

Constructor & Destructor Documentation

igtl::SimpleMutexLock::SimpleMutexLock

(

)

Constructor and destructor left public purposely.

virtual igtl::SimpleMutexLock::~SimpleMutexLock

(

)

[virtual]

Constructor and destructor left public purposely.

---

Member Function Documentation

MutexType& igtl::SimpleMutexLock::GetMutexLock

(

)

[inline]

Access the MutexType member variable from outside this class

Definition at line 111 of file igtlMutexLock.h.

const MutexType igtl::SimpleMutexLock::GetMutexLock

(

)

const [inline]

Access the MutexType member variable from outside this class

Definition at line 115 of file igtlMutexLock.h.

virtual const char* igtl::SimpleMutexLock::GetNameOfClass

(

)

[inline, virtual]

Used for debugging and other run-time purposes.

Definition at line 102 of file igtlMutexLock.h.

void igtl::SimpleMutexLock::Lock

(

void

)

Lock the MutexLock.

Referenced by igtl::MutexLock::Lock().

static SimpleMutexLock* igtl::SimpleMutexLock::New

(

)

[static]

Methods for creation and destruction through the object factory.

void igtl::SimpleMutexLock::Unlock

(

void

)

Unlock the MutexLock.

Referenced by igtl::MutexLock::Unlock().

---

Member Data Documentation

MutexType igtl::SimpleMutexLock::m_MutexLock [protected]

Definition at line 122 of file igtlMutexLock.h.

---

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

• igtlMutexLock.h