Main Page
Groups
Namespace List
Class Hierarchy
Alphabetical List
Compound List
File
List
Namespace Members
Compound Members
File Members
Concepts
itk::ObjectStore< TObjectType > Class Template Reference
A specialized memory management object for allocating and destroying contiguous blocks of objects.
More...
#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.
Member Typedef Documentation
|
|
Type of list for storing pointers to free memory. Definition at line 79 of file itkObjectStore.h. |
Member Enumeration Documentation
|
|
Type of memory allocation strategy - Enumeration values:
-
| LINEAR_GROWTH |
|
| EXPONENTIAL_GROWTH |
|
Definition at line 82 of file itkObjectStore.h. |
Constructor & Destructor Documentation
Member Function Documentation
|
|
Borrow a pointer to an object from the memory store. |
|
|
Frees all memory in the container |
|
template<class TObjectType> |
| virtual const char* itk::ObjectStore< TObjectType >::GetClassName |
( |
|
) |
const [virtual] |
|
|
|
Run-time type information (and related methods).
Reimplemented from itk::Object.
|
|
template<class TObjectType> |
| :: vcl_size_t itk::ObjectStore< TObjectType >::GetGrowthSize |
( |
|
) |
[protected] |
|
|
|
Returns a new size to grow. |
|
|
Set/Get the growth strategy. |
|
template<class TObjectType> |
| virtual :: vcl_size_t itk::ObjectStore< TObjectType >::GetLinearGrowthSize |
( |
|
) |
|
|
|
|
Set/Get the linear growth size |
|
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. |
|
|
Method for creation through the object factory.
Reimplemented from itk::Object.
|
|
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.
|
|
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. |
|
|
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. |
|
|
Set/Get the growth strategy. |
|
template<class TObjectType> |
| void itk::ObjectStore< TObjectType >::SetGrowthStrategyToExponential |
( |
|
) |
[inline] |
|
|
template<class TObjectType> |
| void itk::ObjectStore< TObjectType >::SetGrowthStrategyToLinear |
( |
|
) |
[inline] |
|
|
template<class TObjectType> |
| virtual void itk::ObjectStore< TObjectType >::SetLinearGrowthSize |
( |
::vcl_size_t |
_arg |
) |
[virtual] |
|
|
|
Set/Get the linear growth size |
|
|
Attempts to free memory that is not in use and shrink the size of the container. Not guaranteed to do anything. |
The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:58:36 2007 for ITK by 
1.3.8 written by Dimitri van Heesch,
© 1997-2000