Main Page
Groups
Namespace List
Class Hierarchy
Alphabetical List
Compound List
File
List
Namespace Members
Compound Members
File Members
Concepts
itk::IndexedContainerInterface< TElementIdentifier, TElement > Class Template Reference
[Data Representation Objects]
#include <itkIndexedContainerInterface.h>
Inheritance diagram for itk::IndexedContainerInterface:
[legend]Collaboration diagram for itk::IndexedContainerInterface< TElementIdentifier, TElement >:
[legend]List of all members.
Detailed Description
template<typename TElementIdentifier, typename TElement>
class itk::IndexedContainerInterface< TElementIdentifier, TElement >
This should only be used for reference when writing containers conforming to this interface. ITK uses generic programming to allow container type substitution, so polymorphism is not needed to use containers through this interface. This means that a container conforming to this interface need not be derived from it, and that their methods should not be virtual. However, the container must derive from Object in order to support the reference counting, modification time, and debug information required by this interface.
Note that many comments refer to a "default element" or "default element value". This value is equal to the default constructor of the Element type. Also note that all non-const methods assume that the container was modified, and update the modification time.
Template parameters for IndexedContainerInterface:
TElementIdentifier = A type that shall be used to index the container. It must have a < operator defined for ordering.
TElement = The element type stored in the container.
Definition at line 54 of file itkIndexedContainerInterface.h.
Member Typedef Documentation
|
template<typename TElementIdentifier, typename TElement> |
| typedef SmartPointer<const Self> itk::IndexedContainerInterface< TElementIdentifier, TElement >::ConstPointer
|
|
|
template<typename TElementIdentifier, typename TElement> |
| typedef TElement itk::IndexedContainerInterface< TElementIdentifier, TElement >::Element
|
|
|
template<typename TElementIdentifier, typename TElement> |
| typedef TElementIdentifier itk::IndexedContainerInterface< TElementIdentifier, TElement >::ElementIdentifier
|
|
|
template<typename TElementIdentifier, typename TElement> |
| typedef SmartPointer<Self> itk::IndexedContainerInterface< TElementIdentifier, TElement >::Pointer
|
|
|
template<typename TElementIdentifier, typename TElement> |
| typedef IndexedContainerInterface itk::IndexedContainerInterface< TElementIdentifier, TElement >::Self
|
|
|
template<typename TElementIdentifier, typename TElement> |
| typedef Object itk::IndexedContainerInterface< TElementIdentifier, TElement >::Superclass
|
|
Member Function Documentation
|
template<typename TElementIdentifier, typename TElement> |
| ConstIterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::Begin |
( |
|
) |
const |
|
|
|
Get a begin const iterator for the container. |
|
template<typename TElementIdentifier, typename TElement> |
| Iterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::Begin |
( |
|
) |
|
|
|
|
Get a begin iterator for the container. |
|
template<typename TElementIdentifier, typename TElement> |
| Element& itk::IndexedContainerInterface< TElementIdentifier, TElement >::CreateElementAt |
( |
ElementIdentifier |
|
) |
|
|
|
|
Get a reference to an existing element. It is guaranteed that the element will be inserted with a default value if it does not exist.
It is assumed that the value of the element is modified through the reference. |
|
template<typename TElementIdentifier, typename TElement> |
| void itk::IndexedContainerInterface< TElementIdentifier, TElement >::CreateIndex |
( |
ElementIdentifier |
|
) |
|
|
|
|
Create an entry in the container corresponding to the given index. The entry will be initialized with the default element. If an entry already exists, its value will be overwritten with the default element. |
|
template<typename TElementIdentifier, typename TElement> |
| void itk::IndexedContainerInterface< TElementIdentifier, TElement >::DeleteIndex |
( |
ElementIdentifier |
|
) |
|
|
|
|
Delete the entry in the container corresponding to the given identifier.
It is NOT guaranteed that IndexExists(id) will return false if called right after DeleteIndex(id). This behavior is implementation-defined. If the identifier's location is left behind, though, it will have the value of the default element. |
|
template<typename TElementIdentifier, typename TElement> |
| Element& itk::IndexedContainerInterface< TElementIdentifier, TElement >::ElementAt |
( |
ElementIdentifier |
|
) |
|
|
|
|
Get a reference to an existing element. It is NOT guaranteed that the element will or will not be created if it doesn't exist. This behavior is implementation-specific.
It is assumed that the value of the element is modified through the reference. |
|
template<typename TElementIdentifier, typename TElement> |
| ConstIterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::End |
( |
|
) |
const |
|
|
|
Get an end const iterator for the container. |
|
template<typename TElementIdentifier, typename TElement> |
| Iterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::End |
( |
|
) |
|
|
|
|
Get an end iterator for the container. |
|
template<typename TElementIdentifier, typename TElement> |
| virtual const char* itk::IndexedContainerInterface< TElementIdentifier, TElement >::GetClassName |
( |
|
) |
const [virtual] |
|
|
template<typename TElementIdentifier, typename TElement> |
| Element itk::IndexedContainerInterface< TElementIdentifier, TElement >::GetElement |
( |
ElementIdentifier |
|
) |
const |
|
|
|
Get a copy of an element without range checking. |
|
template<typename TElementIdentifier, typename TElement> |
| bool itk::IndexedContainerInterface< TElementIdentifier, TElement >::GetElementIfIndexExists |
( |
ElementIdentifier |
, |
|
|
Element * |
|
|
) |
const |
|
|
|
Combine the GetElement and IndexExists into one method. If false is returned, then no element with the given identifier was found. If true is returned, then the identifier was found. In this case, if the element pointer given as input is not null, the element is filled in with the value of the element found. |
|
template<typename TElementIdentifier, typename TElement> |
| bool itk::IndexedContainerInterface< TElementIdentifier, TElement >::IndexExists |
( |
ElementIdentifier |
|
) |
const |
|
|
|
Test if there is an entry in the container corresponding to the given index. |
|
template<typename TElementIdentifier, typename TElement> |
| void itk::IndexedContainerInterface< TElementIdentifier, TElement >::Initialize |
( |
void |
|
) |
|
|
|
|
Tell the container to release any memory it may have allocated and return itself to its initial state. |
|
template<typename TElementIdentifier, typename TElement> |
| void itk::IndexedContainerInterface< TElementIdentifier, TElement >::InsertElement |
( |
ElementIdentifier |
, |
|
|
Element |
|
|
) |
|
|
|
|
Set the value of an element. It is guaranteed that a spot for the element will be created if it doesn't exist. |
|
template<typename TElementIdentifier, typename TElement> |
| void itk::IndexedContainerInterface< TElementIdentifier, TElement >::Reserve |
( |
ElementIdentifier |
|
) |
|
|
|
|
Tell the container to allocate enough memory to allow at least as many elements as the size given to be stored. This is NOT guaranteed to actually allocate any memory, but is useful if the implementation of the container allocates contiguous storage. |
|
template<typename TElementIdentifier, typename TElement> |
| void itk::IndexedContainerInterface< TElementIdentifier, TElement >::SetElement |
( |
ElementIdentifier |
, |
|
|
Element |
|
|
) |
|
|
|
|
Set the value of an element. It is NOT guaranteed whether a spot for the element will be created automatically. This is implementation-defined. |
|
template<typename TElementIdentifier, typename TElement> |
| unsigned long itk::IndexedContainerInterface< TElementIdentifier, TElement >::Size |
( |
void |
|
) |
const |
|
|
|
Get the number of elements currently stored in the container. |
|
template<typename TElementIdentifier, typename TElement> |
| void itk::IndexedContainerInterface< TElementIdentifier, TElement >::Squeeze |
( |
void |
|
) |
|
|
|
|
Tell the container to try to minimize its memory usage for storage of the current number of elements. This is NOT guaranteed to decrease memory usage. |
The documentation for this class was generated from the following file:
Generated at Fri May 21 01:30:07 2004 for ITK by
1.2.15 written by Dimitri van Heesch,
© 1997-2000