Detailed Description

template<typename 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.

Warning: 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 63 of file itkObjectStore.h.

Classes
struct	MemoryBlock

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 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
ObjectType *	Borrow ()

void	Clear ()

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

virtual const char *	GetNameOfClass () const

virtual SizeValueType	GetSize () const

void	Reserve (SizeValueType n)

void	Return (ObjectType *p)

void	SetGrowthStrategyToExponential ()

void	SetGrowthStrategyToLinear ()

void	Squeeze ()


virtual void	SetLinearGrowthSize (SizeValueType _arg)

virtual SizeValueType	GetLinearGrowthSize () const


virtual void	SetGrowthStrategy (GrowthStrategyType _arg)

virtual GrowthStrategyType	GetGrowthStrategy () const

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
SizeValueType	GetGrowthSize ()

	ObjectStore ()

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

	~ObjectStore ()

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 ()

Private Member Functions
	ObjectStore (const Self &) ITK_DELETE_FUNCTION

void	operator= (const Self &) ITK_DELETE_FUNCTION

Private Attributes
FreeListType	m_FreeList

GrowthStrategyType	m_GrowthStrategy

SizeValueType	m_LinearGrowthSize

SizeValueType	m_Size

std::vector< MemoryBlock >	m_Store

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount