ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ObjectStore< TObjectType > Class Template Reference

#include <itkObjectStore.h>

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 84 of file itkObjectStore.h.

+ Inheritance diagram for itk::ObjectStore< TObjectType >:
+ Collaboration diagram for itk::ObjectStore< TObjectType >:

Classes

struct  MemoryBlock
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FreeListType = std::vector< ObjectType * >
 
using GrowthStrategyEnum = ObjectStoreEnums::GrowthStrategy
 
using ObjectType = TObjectType
 
using Pointer = SmartPointer< Self >
 
using Self = ObjectStore
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

ObjectTypeBorrow ()
 
void Clear ()
 
const char * GetNameOfClass () const override
 
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 (const GrowthStrategyEnum _arg)
 
virtual GrowthStrategyEnum GetGrowthStrategy () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
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::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

SizeValueType GetGrowthSize ()
 
 ObjectStore ()=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ObjectStore () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

FreeListType m_FreeList {}
 
GrowthStrategyEnum m_GrowthStrategy { GrowthStrategyEnum::EXPONENTIAL_GROWTH }
 
SizeValueType m_LinearGrowthSize { 1024 }
 
SizeValueType m_Size {}
 
std::vector< MemoryBlockm_Store {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TObjectType >
using itk::ObjectStore< TObjectType >::ConstPointer = SmartPointer<const Self>

Definition at line 93 of file itkObjectStore.h.

◆ FreeListType

template<typename TObjectType >
using itk::ObjectStore< TObjectType >::FreeListType = std::vector<ObjectType *>

Type of list for storing pointers to free memory.

Definition at line 105 of file itkObjectStore.h.

◆ GrowthStrategyEnum

template<typename TObjectType >
using itk::ObjectStore< TObjectType >::GrowthStrategyEnum = ObjectStoreEnums::GrowthStrategy

Definition at line 107 of file itkObjectStore.h.

◆ ObjectType

template<typename TObjectType >
using itk::ObjectStore< TObjectType >::ObjectType = TObjectType

Type of the objects in storage.

Definition at line 102 of file itkObjectStore.h.

◆ Pointer

template<typename TObjectType >
using itk::ObjectStore< TObjectType >::Pointer = SmartPointer<Self>

Definition at line 92 of file itkObjectStore.h.

◆ Self

template<typename TObjectType >
using itk::ObjectStore< TObjectType >::Self = ObjectStore

Standard type alias.

Definition at line 90 of file itkObjectStore.h.

◆ Superclass

template<typename TObjectType >
using itk::ObjectStore< TObjectType >::Superclass = Object

Definition at line 91 of file itkObjectStore.h.

Constructor & Destructor Documentation

◆ ObjectStore()

template<typename TObjectType >
itk::ObjectStore< TObjectType >::ObjectStore ( )
protecteddefault

◆ ~ObjectStore()

template<typename TObjectType >
itk::ObjectStore< TObjectType >::~ObjectStore ( )
overrideprotected

Member Function Documentation

◆ Borrow()

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

Borrow a pointer to an object from the memory store.

◆ Clear()

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

Frees all memory in the container

◆ GetGrowthSize()

template<typename TObjectType >
SizeValueType itk::ObjectStore< TObjectType >::GetGrowthSize ( )
protected

Returns a new size to grow.

◆ GetGrowthStrategy()

template<typename TObjectType >
virtual GrowthStrategyEnum itk::ObjectStore< TObjectType >::GetGrowthStrategy ( ) const
virtual

Set/Get the growth strategy.

◆ GetLinearGrowthSize()

template<typename TObjectType >
virtual SizeValueType itk::ObjectStore< TObjectType >::GetLinearGrowthSize ( ) const
virtual

Set/Get the linear growth size

◆ GetNameOfClass()

template<typename TObjectType >
const char * itk::ObjectStore< TObjectType >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetSize()

template<typename TObjectType >
virtual SizeValueType itk::ObjectStore< TObjectType >::GetSize ( ) const
virtual

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

◆ New()

template<typename TObjectType >
static Pointer itk::ObjectStore< TObjectType >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TObjectType >
void itk::ObjectStore< TObjectType >::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.

◆ Reserve()

template<typename TObjectType >
void itk::ObjectStore< TObjectType >::Reserve ( SizeValueType  n)

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

◆ Return()

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

◆ SetGrowthStrategy()

template<typename TObjectType >
virtual void itk::ObjectStore< TObjectType >::SetGrowthStrategy ( const GrowthStrategyEnum  _arg)
virtual

Set/Get the growth strategy.

◆ SetGrowthStrategyToExponential()

template<typename TObjectType >
void itk::ObjectStore< TObjectType >::SetGrowthStrategyToExponential ( )
inline

Set growth strategy to exponential

Definition at line 155 of file itkObjectStore.h.

◆ SetGrowthStrategyToLinear()

template<typename TObjectType >
void itk::ObjectStore< TObjectType >::SetGrowthStrategyToLinear ( )
inline

Set growth strategy to linear

Definition at line 162 of file itkObjectStore.h.

◆ SetLinearGrowthSize()

template<typename TObjectType >
virtual void itk::ObjectStore< TObjectType >::SetLinearGrowthSize ( SizeValueType  _arg)
virtual

Set/Get the linear growth size

◆ Squeeze()

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

Member Data Documentation

◆ m_FreeList

template<typename TObjectType >
FreeListType itk::ObjectStore< TObjectType >::m_FreeList {}
private

Pointers to objects available for borrowing.

Definition at line 206 of file itkObjectStore.h.

◆ m_GrowthStrategy

template<typename TObjectType >
GrowthStrategyEnum itk::ObjectStore< TObjectType >::m_GrowthStrategy { GrowthStrategyEnum::EXPONENTIAL_GROWTH }
private

Definition at line 200 of file itkObjectStore.h.

◆ m_LinearGrowthSize

template<typename TObjectType >
SizeValueType itk::ObjectStore< TObjectType >::m_LinearGrowthSize { 1024 }
private

Definition at line 203 of file itkObjectStore.h.

◆ m_Size

template<typename TObjectType >
SizeValueType itk::ObjectStore< TObjectType >::m_Size {}
private

Definition at line 202 of file itkObjectStore.h.

◆ m_Store

template<typename TObjectType >
std::vector<MemoryBlock> itk::ObjectStore< TObjectType >::m_Store {}
private

A list of MemoryBlocks that have been allocated.

Definition at line 209 of file itkObjectStore.h.


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