itk::ObjectStore< TObjectType > Class Template Reference

#include <itkObjectStore.h>

Inheritance diagram for itk::ObjectStore< TObjectType >:

[legend]Collaboration diagram for itk::ObjectStore< TObjectType >:

[legend]List of all members.

---

Detailed Description

template<class TObjectType>
class itk::ObjectStore< TObjectType >

A specialized memory management object for allocating and destroying contiguous blocks of objects.

ObjectStore implements a dynamically sizeable free memory store, from which instantiated objects can be borrowed and returned without always invoking calls to new/delete. This type of memory management is useful in situations where calls to new/delete may be expensive, such as a multithreaded environment to avoid the heap contention problem.

ObjectStore is designed to grow dynamically. Shrinking is a more difficult problem and is only done if it will not invalidate any pointers that have been "lent" to a calling application.

This implementation uses a very simple, list-based scheme to manage pointers that have been borrowed and returned. Memory overhead incurred is one pointer per object allocated. Because of this overhead, ObjectStore is not efficient for use with small objects such as native types.

Important notes on thread-safety: This object is thread-safe in the same sense that STL defines thread-safety: simultaneous operations on distinct containers are safe. It is the user's responsibility to apply appropriate mutex locks if the same container is used across multiple threads. One (or more) ObjectStore's can be safely be created for each thread -- and may even be more efficient in terms of memory use than sharing a single ObjectStore across threads. Calls to {new} and {delete} have been placed in critical sections in case a compiler's implementation of new/delete is not thread-safe.

Warnings: For efficiency reasons, the ObjectStore does not guard against the same pointer being Returned() more than once. Doing this could result in serious problems.

Definition at line 60 of file itkObjectStore.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef std::vector< ObjectType * >	FreeListType
enum	GrowthStrategyType {   LINEAR_GROWTH = 0,   EXPONENTIAL_GROWTH = 1 }
typedef TObjectType	ObjectType
typedef SmartPointer< Self >	Pointer
typedef ObjectStore	Self
typedef Object	Superclass
Public Member Functions
ObjectType *	Borrow ()
void	Clear ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual GrowthStrategyType	GetGrowthStrategy ()
virtual ::vcl_size_t	GetLinearGrowthSize ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
virtual ::vcl_size_t	GetSize ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	Reserve (::vcl_size_t n)
void	Return (ObjectType *p)
void	SetDebug (bool debugFlag) const
Set Get the growth strategy *virtual void	SetGrowthStrategy (GrowthStrategyType _arg)
void	SetGrowthStrategyToExponential ()
void	SetGrowthStrategyToLinear ()
Set Get the linear growth size *virtual void	SetLinearGrowthSize (::vcl_size_t _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
void	Squeeze ()
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
::vcl_size_t	GetGrowthSize ()
	ObjectStore ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	~ObjectStore ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Classes
struct	MemoryBlock

---

Member Typedef Documentation

template<class TObjectType> typedef SmartPointer<const Self> itk::ObjectStore< TObjectType >::ConstPointer

Reimplemented from itk::Object. Definition at line 67 of file itkObjectStore.h.

template<class TObjectType> typedef std::vector<ObjectType *> itk::ObjectStore< TObjectType >::FreeListType

Type of list for storing pointers to free memory. Definition at line 79 of file itkObjectStore.h.

template<class TObjectType> typedef TObjectType itk::ObjectStore< TObjectType >::ObjectType

Type of the objects in storage. Definition at line 73 of file itkObjectStore.h.

template<class TObjectType> typedef SmartPointer<Self> itk::ObjectStore< TObjectType >::Pointer

Reimplemented from itk::Object. Definition at line 66 of file itkObjectStore.h.

template<class TObjectType> typedef ObjectStore itk::ObjectStore< TObjectType >::Self

Standard typedefs. Reimplemented from itk::Object. Definition at line 64 of file itkObjectStore.h.

template<class TObjectType> typedef Object itk::ObjectStore< TObjectType >::Superclass

Reimplemented from itk::Object. Definition at line 65 of file itkObjectStore.h.

---

Member Enumeration Documentation

template<class TObjectType> enum itk::ObjectStore::GrowthStrategyType

Type of memory allocation strategy Enumeration values: LINEAR_GROWTH  EXPONENTIAL_GROWTH  Definition at line 82 of file itkObjectStore.h.

---

Constructor & Destructor Documentation

template<class TObjectType> itk::ObjectStore< TObjectType >::ObjectStore (   )  [protected]

template<class TObjectType> itk::ObjectStore< TObjectType >::~ObjectStore (   )  [protected]

---

Member Function Documentation

template<class TObjectType> ObjectType* itk::ObjectStore< TObjectType >::Borrow (   )

Borrow a pointer to an object from the memory store.

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<class TObjectType> void itk::ObjectStore< TObjectType >::Clear (   )

Frees all memory in the container

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

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk 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.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class TObjectType> :: vcl_size_t itk::ObjectStore< TObjectType >::GetGrowthSize (   )  [protected]

Returns a new size to grow.

template<class TObjectType> virtual GrowthStrategyType itk::ObjectStore< TObjectType >::GetGrowthStrategy (   )  [virtual]

template<class TObjectType> virtual :: vcl_size_t itk::ObjectStore< TObjectType >::GetLinearGrowthSize (   )

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TObjectType> virtual const char* itk::ObjectStore< TObjectType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TObjectType> virtual :: vcl_size_t itk::ObjectStore< TObjectType >::GetSize (   )

Returns the size of the container. This is not the number of objects available, but the total number of objects allocated.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TObjectType> static Pointer itk::ObjectStore< TObjectType >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TObjectType> virtual void itk::ObjectStore< TObjectType >::PrintSelf (  std::ostream &  os, Indent  indent )  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 itk::Object.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

template<class TObjectType> void itk::ObjectStore< TObjectType >::Reserve (  ::vcl_size_t  n  )

Ensures that there are at least n elements allocated in the storage container. Will not shrink the container, but may enlarge the container.

template<class TObjectType> void itk::ObjectStore< TObjectType >::Return (  ObjectType *  p  )

Return a pointer to the memory store for reuse. WARNING: The ObjectStore assumes a pointer is returned exactly once after each time it has been borrowed.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TObjectType> Set Get the growth strategy* virtual void itk::ObjectStore< TObjectType >::SetGrowthStrategy (  GrowthStrategyType  _arg  )  [virtual]

template<class TObjectType> void itk::ObjectStore< TObjectType >::SetGrowthStrategyToExponential (   )  [inline]

Set growth strategy to exponential Definition at line 119 of file itkObjectStore.h.

template<class TObjectType> void itk::ObjectStore< TObjectType >::SetGrowthStrategyToLinear (   )  [inline]

Set growth strategy to linear Definition at line 123 of file itkObjectStore.h.

template<class TObjectType> Set Get the linear growth size* virtual void itk::ObjectStore< TObjectType >::SetLinearGrowthSize (  ::vcl_size_t  _arg  )  [virtual]

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TObjectType> void itk::ObjectStore< TObjectType >::Squeeze (   )

Attempts to free memory that is not in use and shrink the size of the container. Not guaranteed to do anything.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkObjectStore.h

---