Critical section locking class. More...
#include <igtlFastMutexLock.h>
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef FastMutexLock | Self |
typedef Object | Superclass |
Public Member Functions | |
virtual LightObject::Pointer | CreateAnother () const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
virtual void | Delete () |
bool | GetDebug () const |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
igtlNewMacro (Self) | |
igtlTypeMacro (FastMutexLock, Object) | |
igtlTypeMacro (Object, LightObject) | |
void | Lock () |
void | Print (std::ostream &os) const |
virtual void | Register () const |
void | SetDebug (bool debugFlag) const |
virtual void | SetReferenceCount (int) |
void | Unlock () |
virtual void | UnRegister () const |
Static Public Member Functions | |
static void | BreakOnError () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
Protected Member Functions | |
FastMutexLock () | |
void | PrintSelf (std::ostream &os) const |
~FastMutexLock () | |
virtual void | PrintHeader (std::ostream &os) const |
virtual void | PrintTrailer (std::ostream &os) const |
Protected Attributes | |
volatile int | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
SimpleFastMutexLock | m_SimpleFastMutexLock |
Critical section locking class.
FastMutexLock allows the locking of variables which are accessed through different threads. This header file also defines SimpleFastMutexLock which is not a subclass of Object. The API is identical to that of MutexLock, and the behavior is identical as well, except on Windows 9x/NT platforms. The only difference on these platforms is that MutexLock is more flexible, in that it works across processes as well as across threads, but also costs more, in that it evokes a 600-cycle x86 ring transition. The FastMutexLock provides a higher-performance equivalent (on Windows) but won't work across processes. Since it is unclear how, in igtl, an object at the igtl level can be shared across processes in the first place, one should use FastMutexLock unless one has a very good reason to use MutexLock. If higher-performance equivalents for non-Windows platforms (Irix, SunOS, etc) are discovered, they should replace the implementations in this class
Definition at line 66 of file igtlFastMutexLock.h.
typedef SmartPointer<const Self> igtl::FastMutexLock::ConstPointer |
Reimplemented from igtl::Object.
Definition at line 73 of file igtlFastMutexLock.h.
typedef SmartPointer<Self> igtl::FastMutexLock::Pointer |
Reimplemented from igtl::Object.
Definition at line 72 of file igtlFastMutexLock.h.
Standard class typedefs.
Reimplemented from igtl::Object.
Definition at line 70 of file igtlFastMutexLock.h.
Reimplemented from igtl::Object.
Definition at line 71 of file igtlFastMutexLock.h.
igtl::FastMutexLock::FastMutexLock | ( | ) | [inline, protected] |
Definition at line 88 of file igtlFastMutexLock.h.
igtl::FastMutexLock::~FastMutexLock | ( | ) | [inline, protected] |
Definition at line 89 of file igtlFastMutexLock.h.
static void igtl::LightObject::BreakOnError | ( | ) | [static, inherited] |
This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.
virtual LightObject::Pointer igtl::Object::CreateAnother | ( | ) | const [virtual, inherited] |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from igtl::LightObject.
virtual void igtl::Object::DebugOff | ( | ) | const [virtual, inherited] |
Turn debugging output off.
virtual void igtl::Object::DebugOn | ( | ) | const [virtual, inherited] |
Turn debugging output on.
virtual void igtl::LightObject::Delete | ( | ) | [virtual, inherited] |
Delete an igtl object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.
bool igtl::Object::GetDebug | ( | ) | const [inherited] |
Get the value of the debug flag.
static bool igtl::Object::GetGlobalWarningDisplay | ( | ) | [static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual const char* igtl::LightObject::GetNameOfClass | ( | ) | const [inline, virtual, inherited] |
Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.
Definition at line 86 of file igtlLightObject.h.
virtual int igtl::LightObject::GetReferenceCount | ( | ) | const [inline, virtual, inherited] |
Gets the reference count on this object.
Definition at line 112 of file igtlLightObject.h.
static void igtl::Object::GlobalWarningDisplayOff | ( | ) | [inline, static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Definition at line 118 of file igtlObject.h.
References igtl::Object::SetGlobalWarningDisplay().
static void igtl::Object::GlobalWarningDisplayOn | ( | ) | [inline, static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Definition at line 116 of file igtlObject.h.
References igtl::Object::SetGlobalWarningDisplay().
igtl::FastMutexLock::igtlNewMacro | ( | Self | ) |
Method for creation.
igtl::FastMutexLock::igtlTypeMacro | ( | FastMutexLock | , |
Object | |||
) |
Run-time type information.
igtl::Object::igtlTypeMacro | ( | Object | , |
LightObject | |||
) | [inherited] |
Standard part of all igtl objects.
void igtl::FastMutexLock::Lock | ( | void | ) | [inline] |
Lock the igtlFastMutexLock.
Definition at line 100 of file igtlFastMutexLock.h.
References igtl::SimpleFastMutexLock::Lock(), and m_SimpleFastMutexLock.
static Pointer igtl::Object::New | ( | ) | [static, inherited] |
Method for creation through the object factory.
Reimplemented from igtl::LightObject.
Referenced by igtl::CreateObjectFunction< T >::CreateObject().
void igtl::LightObject::Print | ( | std::ostream & | os | ) | const [inherited] |
Cause the object to print itself out.
virtual void igtl::LightObject::PrintHeader | ( | std::ostream & | os | ) | const [protected, virtual, inherited] |
void igtl::FastMutexLock::PrintSelf | ( | std::ostream & | os | ) | const [protected, virtual] |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from igtl::Object.
virtual void igtl::LightObject::PrintTrailer | ( | std::ostream & | os | ) | const [protected, virtual, inherited] |
virtual void igtl::Object::Register | ( | ) | const [virtual, inherited] |
Return this objects modified time. Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Increase the reference count (mark as used by another object).
Reimplemented from igtl::LightObject.
void igtl::Object::SetDebug | ( | bool | debugFlag | ) | const [inherited] |
Set the value of the debug flag. A non-zero value turns debugging on.
static void igtl::Object::SetGlobalWarningDisplay | ( | bool | flag | ) | [static, inherited] |
This is a global flag that controls whether any debug, warning or error messages are displayed.
Referenced by igtl::Object::GlobalWarningDisplayOff(), and igtl::Object::GlobalWarningDisplayOn().
virtual void igtl::Object::SetReferenceCount | ( | int | ) | [virtual, inherited] |
Sets the reference count (use with care)
Reimplemented from igtl::LightObject.
void igtl::FastMutexLock::Unlock | ( | void | ) | [inline] |
Unlock the FastMutexLock.
Definition at line 105 of file igtlFastMutexLock.h.
References m_SimpleFastMutexLock, and igtl::SimpleFastMutexLock::Unlock().
virtual void igtl::Object::UnRegister | ( | ) | const [virtual, inherited] |
Decrease the reference count (release by another object).
Reimplemented from igtl::LightObject.
volatile int igtl::LightObject::m_ReferenceCount [mutable, protected, inherited] |
Number of uses of this object by other objects.
Definition at line 133 of file igtlLightObject.h.
SimpleFastMutexLock igtl::LightObject::m_ReferenceCountLock [mutable, protected, inherited] |
Mutex lock to protect modification to the reference count
Definition at line 136 of file igtlLightObject.h.
Definition at line 91 of file igtlFastMutexLock.h.