itk::MutexLock Class Reference

#include <itkMutexLock.h>

Inheritance diagram for itk::MutexLock:

Collaboration diagram for itk::MutexLock:

Detailed Description

Mutual exclusion locking class.

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

Definition at line 103 of file itkMutexLock.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef MutexLock	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () 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
	MutexLock ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const override
	~MutexLock ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
SimpleMutexLock	m_SimpleMutexLock
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
	MutexLock (const Self &) ITK_DELETE_FUNCTION
void	operator= (const Self &) ITK_DELETE_FUNCTION

Member Typedef Documentation

typedef SmartPointer< const Self > itk::MutexLock::ConstPointer

Definition at line 110 of file itkMutexLock.h.

typedef SmartPointer< Self > itk::MutexLock::Pointer

Definition at line 109 of file itkMutexLock.h.

typedef MutexLock itk::MutexLock::Self

Standard class typedefs.

Definition at line 107 of file itkMutexLock.h.

typedef Object itk::MutexLock::Superclass

Definition at line 108 of file itkMutexLock.h.

Constructor & Destructor Documentation

itk::MutexLock::MutexLock ( )

inlineprotected

Definition at line 130 of file itkMutexLock.h.

itk::MutexLock::~MutexLock ( )

inlineprotected

Definition at line 131 of file itkMutexLock.h.

itk::MutexLock::MutexLock ( const Self &  )

private

Member Function Documentation

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

virtual

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::MutexLock::GetNameOfClass ( ) const

virtual

Run-time information.

Reimplemented from itk::Object.

void itk::MutexLock::Lock ( )

inline

Lock the itkMutexLock.

Definition at line 141 of file itkMutexLock.h.

References Lock().

Referenced by Lock().

static Pointer itk::MutexLock::New ( )

static

Method for creation.

void itk::MutexLock::operator= ( const Self &  )

private

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

overrideprotectedvirtual

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::MutexLock::TryLock ( )

inline

Non-blocking Lock access.

Returns

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

Definition at line 146 of file itkMutexLock.h.

void itk::MutexLock::Unlock ( )

inline

Unlock the MutexLock.

Definition at line 151 of file itkMutexLock.h.

Member Data Documentation

SimpleMutexLock itk::MutexLock::m_SimpleMutexLock

protected

Definition at line 133 of file itkMutexLock.h.

---

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

• itkMutexLock.h