Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  
Public Types | Public Member Functions | Protected Attributes | List of all members
igtl::SimpleMutexLock Class Reference

#include <igtlMutexLock.h>

Public Types

typedef SimpleMutexLock Self
 

Public Member Functions

virtual const char * GetNameOfClass ()
 
void Lock (void)
 
void Unlock (void)
 
 SimpleMutexLock ()
 
virtual ~SimpleMutexLock ()
 
MutexTypeGetMutexLock ()
 
const MutexType GetMutexLock () const
 

Static Public Member Functions

static SimpleMutexLockNew ()
 

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

Member Typedef Documentation

◆ Self

Standard class typedefs.

Definition at line 87 of file igtlMutexLock.h.

Constructor & Destructor Documentation

◆ SimpleMutexLock()

igtl::SimpleMutexLock::SimpleMutexLock ( )

Constructor and destructor left public purposely.

◆ ~SimpleMutexLock()

virtual igtl::SimpleMutexLock::~SimpleMutexLock ( )
virtual

Constructor and destructor left public purposely.

Member Function Documentation

◆ GetMutexLock() [1/2]

MutexType& igtl::SimpleMutexLock::GetMutexLock ( )
inline

Access the MutexType member variable from outside this class

Definition at line 109 of file igtlMutexLock.h.

◆ GetMutexLock() [2/2]

const MutexType igtl::SimpleMutexLock::GetMutexLock ( ) const
inline

Access the MutexType member variable from outside this class

Definition at line 113 of file igtlMutexLock.h.

◆ GetNameOfClass()

virtual const char* igtl::SimpleMutexLock::GetNameOfClass ( )
inlinevirtual

Used for debugging and other run-time purposes.

Definition at line 100 of file igtlMutexLock.h.

◆ Lock()

void igtl::SimpleMutexLock::Lock ( void  )

Lock the MutexLock.

◆ New()

static SimpleMutexLock* igtl::SimpleMutexLock::New ( )
static

Methods for creation and destruction through the object factory.

◆ Unlock()

void igtl::SimpleMutexLock::Unlock ( void  )

Unlock the MutexLock.

Member Data Documentation

◆ m_MutexLock

MutexType igtl::SimpleMutexLock::m_MutexLock
protected

Definition at line 120 of file igtlMutexLock.h.


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

Generated at Sat Apr 15 2017 02:30:07 for OpenIGTLink by doxygen 1.8.13 written by Dimitri van Heesch, © 1997-2012