 |
ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkIndexedContainerInterface.h>
Inheritance diagram for itk::IndexedContainerInterface< TElementIdentifier, TElement >: Collaboration diagram for itk::IndexedContainerInterface< TElementIdentifier, TElement >:Classes | |
| class | ConstIterator |
| Support const iteration operations through a container. Dereferencing the iterator must provide an object with the following methods: ElementIdentifier Index(void) const; const Element& Value(void) const;. More... | |
| class | Iterator |
| Support iteration operations through a container. Dereferencing the iterator must provide an object with the following methods: ElementIdentifier Index(void) const; Element& Value(void);. More... | |
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef TElement | Element |
| typedef TElementIdentifier | ElementIdentifier |
| typedef SmartPointer< Self > | Pointer |
| typedef IndexedContainerInterface | Self |
| typedef Object | Superclass |
Public Member Functions | |
| Iterator | Begin () |
| ConstIterator | Begin () const |
| Element & | CreateElementAt (ElementIdentifier) |
| void | CreateIndex (ElementIdentifier) |
| void | DeleteIndex (ElementIdentifier) |
| Element & | ElementAt (ElementIdentifier) |
| Iterator | End () |
| ConstIterator | End () const |
| Element | GetElement (ElementIdentifier) const |
| bool | GetElementIfIndexExists (ElementIdentifier, Element *) const |
| virtual const char * | GetNameOfClass () const |
| bool | IndexExists (ElementIdentifier) const |
| void | Initialize (void) |
| void | InsertElement (ElementIdentifier, Element) |
| void | Reserve (ElementIdentifier) |
| void | SetElement (ElementIdentifier, Element) |
| ElementIdentifier | Size (void) const |
| void | Squeeze (void) |
This should only be used for reference when writing containers conforming to this interface. 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.
| 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 53 of file itkIndexedContainerInterface.h.
| typedef SmartPointer< const Self > itk::IndexedContainerInterface< TElementIdentifier, TElement >::ConstPointer |
Reimplemented from itk::Object.
Definition at line 60 of file itkIndexedContainerInterface.h.
| typedef TElement itk::IndexedContainerInterface< TElementIdentifier, TElement >::Element |
Definition at line 67 of file itkIndexedContainerInterface.h.
| typedef TElementIdentifier itk::IndexedContainerInterface< TElementIdentifier, TElement >::ElementIdentifier |
Save the template parameters.
Definition at line 63 of file itkIndexedContainerInterface.h.
| typedef SmartPointer< Self > itk::IndexedContainerInterface< TElementIdentifier, TElement >::Pointer |
Reimplemented from itk::Object.
Definition at line 59 of file itkIndexedContainerInterface.h.
| typedef IndexedContainerInterface itk::IndexedContainerInterface< TElementIdentifier, TElement >::Self |
Standard class typedefs.
Reimplemented from itk::Object.
Definition at line 57 of file itkIndexedContainerInterface.h.
| typedef Object itk::IndexedContainerInterface< TElementIdentifier, TElement >::Superclass |
Reimplemented from itk::Object.
Definition at line 58 of file itkIndexedContainerInterface.h.
| Iterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::Begin | ( | ) |
Get a begin iterator for the container.
| ConstIterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::Begin | ( | ) | const |
Get a begin const iterator for the container.
| 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.
| 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.
| 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.
| 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.
| Iterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::End | ( | ) |
Get an end iterator for the container.
| ConstIterator itk::IndexedContainerInterface< TElementIdentifier, TElement >::End | ( | ) | const |
Get an end const iterator for the container.
| Element itk::IndexedContainerInterface< TElementIdentifier, TElement >::GetElement | ( | ElementIdentifier | ) | const |
Get a copy of an element without range checking.
| 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.
| virtual const char* itk::IndexedContainerInterface< TElementIdentifier, TElement >::GetNameOfClass | ( | ) | const [virtual] |
Standard part of every itk Object.
Reimplemented from itk::Object.
| bool itk::IndexedContainerInterface< TElementIdentifier, TElement >::IndexExists | ( | ElementIdentifier | ) | const |
Test if there is an entry in the container corresponding to the given index.
| 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.
| 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.
| 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.
| 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.
| ElementIdentifier itk::IndexedContainerInterface< TElementIdentifier, TElement >::Size | ( | void | ) | const |
Get the number of elements currently stored in the container.
| 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.
1.7.6.1
