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

#include <itkBarrier.h>

+ Inheritance diagram for itk::Barrier:
+ Collaboration diagram for itk::Barrier:

Detailed Description

Standard barrier class implementation for synchronizing the execution of threads.

A barrier class is used to synchronize threaded execution by allowing threads to block until each has reached a desired state. As each thread enters the barrier it blocks. When all threads have entered the barrier, all released and continue to execute.

A thread enters the barrier by calling Wait() on the barrier class. To set up a barrier class, call Initialize(n) where n is the number of waiting threads that will trigger a release of the barrier.

Definition at line 41 of file itkBarrier.h.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Barrier 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 Initialize (unsigned int)
void Wait ()
- 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
virtual void Register () const
virtual void SetReferenceCount (int)
virtual void UnRegister () const noexcept

Static Public Member Functions

static Pointer New ()
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
static Pointer New ()

Private Member Functions

 Barrier ()
 ~Barrier () override

Private Attributes

ConditionVariable::Pointer m_ConditionVariable
SimpleMutexLock m_Mutex
unsigned int m_NumberArrived
unsigned int m_NumberExpected

Additional Inherited Members

- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount

Member Typedef Documentation

Definition at line 50 of file itkBarrier.h.

Definition at line 49 of file itkBarrier.h.

Standard class typedefs.

Definition at line 47 of file itkBarrier.h.

Definition at line 48 of file itkBarrier.h.

Constructor & Destructor Documentation

itk::Barrier::Barrier ( )
itk::Barrier::~Barrier ( )

Member Function Documentation

virtual::itk::LightObject::Pointer itk::Barrier::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::LightObject.

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

Run-time type information (and related methods).

Reimplemented from itk::LightObject.

void itk::Barrier::Initialize ( unsigned  int)

Creates a new system variable used to implement the barrier. The argument to this method is the number of threads that must Wait() on the barrier before it is cleared.

static Pointer itk::Barrier::New ( )
void itk::Barrier::Wait ( )

A thread calling this method waits until m_NumberOfThreads have called Wait() on the barrier. When the final expected thread calls Wait(), all threads are released.

Member Data Documentation

ConditionVariable::Pointer itk::Barrier::m_ConditionVariable

Definition at line 74 of file itkBarrier.h.

SimpleMutexLock itk::Barrier::m_Mutex

Definition at line 75 of file itkBarrier.h.

unsigned int itk::Barrier::m_NumberArrived

Definition at line 72 of file itkBarrier.h.

unsigned int itk::Barrier::m_NumberExpected

Definition at line 73 of file itkBarrier.h.

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