ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::FastMutexLock Class Reference

#include <itkFastMutexLock.h>

+ Inheritance diagram for itk::FastMutexLock:
+ Collaboration diagram for itk::FastMutexLock:

Detailed Description

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 itk, an object at the itk 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 59 of file itkFastMutexLock.h.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef FastMutexLock Self
typedef Object Superclass
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Object Self
typedef LightObject Superclass
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef LightObject Self

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
virtual const char * GetNameOfClass () const
void Lock ()
bool TryLock ()
void Unlock ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary ()
const MetaDataDictionaryGetMetaDataDictionary () const
virtual ModifiedTimeType GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const override
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int) override
virtual void UnRegister () const noexceptoverride
virtual void SetObjectName (std::string _arg)
virtual const std::string & GetObjectName () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static Pointer New ()
static void SetGlobalWarningDisplay (bool flag)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
static Pointer New ()

Protected Member Functions

 FastMutexLock ()
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 ~FastMutexLock () override
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object () override
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Protected Attributes

SimpleFastMutexLock m_SimpleFastMutexLock
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount

Member Typedef Documentation

Definition at line 66 of file itkFastMutexLock.h.

Definition at line 65 of file itkFastMutexLock.h.

Standard class typedefs.

Definition at line 63 of file itkFastMutexLock.h.

Definition at line 64 of file itkFastMutexLock.h.

Constructor & Destructor Documentation

itk::FastMutexLock::FastMutexLock ( )

Definition at line 86 of file itkFastMutexLock.h.

itk::FastMutexLock::~FastMutexLock ( )

Definition at line 87 of file itkFastMutexLock.h.

Member Function Documentation

virtual::itk::LightObject::Pointer itk::FastMutexLock::CreateAnother ( ) const

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 itk::Object.

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

Run-time type information.

Reimplemented from itk::Object.

void itk::FastMutexLock::Lock ( )

Lock the itkFastMutexLock.

Definition at line 96 of file itkFastMutexLock.h.

References itk::SimpleFastMutexLock::Lock(), and m_SimpleFastMutexLock.

static Pointer itk::FastMutexLock::New ( )

Method for creation.

virtual void itk::FastMutexLock::PrintSelf ( std::ostream &  os,
Indent  indent 
) const

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 itk::Object.

bool itk::FastMutexLock::TryLock ( )

Non-blocking Lock access.

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

Definition at line 101 of file itkFastMutexLock.h.

References m_SimpleFastMutexLock, and itk::SimpleFastMutexLock::TryLock().

void itk::FastMutexLock::Unlock ( )

Unlock the FastMutexLock.

Definition at line 106 of file itkFastMutexLock.h.

References m_SimpleFastMutexLock, and itk::SimpleFastMutexLock::Unlock().

Member Data Documentation

SimpleFastMutexLock itk::FastMutexLock::m_SimpleFastMutexLock

Definition at line 89 of file itkFastMutexLock.h.

Referenced by Lock(), TryLock(), and Unlock().

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