ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkMapContainer.h>
A wrapper of the STL "map" container.
Define a front-end to the STL "map" container that conforms to the IndexedContainerInterface. This is a full-fleged Object, so there are events, modification time, debug, and reference count information.
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 45 of file itkMapContainer.h.
typedef SmartPointer< const Self > itk::MapContainer< TElementIdentifier, TElement >::ConstPointer |
Reimplemented from itk::Object.
Definition at line 54 of file itkMapContainer.h.
typedef TElement itk::MapContainer< TElementIdentifier, TElement >::Element |
Save the template parameters.
Definition at line 61 of file itkMapContainer.h.
typedef TElementIdentifier itk::MapContainer< TElementIdentifier, TElement >::ElementIdentifier |
Save the template parameters.
Definition at line 57 of file itkMapContainer.h.
typedef MapType::const_iterator itk::MapContainer< TElementIdentifier, TElement >::MapConstIterator [private] |
Definition at line 70 of file itkMapContainer.h.
typedef MapType::iterator itk::MapContainer< TElementIdentifier, TElement >::MapIterator [private] |
Definition at line 69 of file itkMapContainer.h.
typedef MapType::key_compare itk::MapContainer< TElementIdentifier, TElement >::MapKeyCompareType [private] |
Definition at line 71 of file itkMapContainer.h.
typedef std::map< ElementIdentifier, Element > itk::MapContainer< TElementIdentifier, TElement >::MapType [private] |
Quick access to the STL map type that was inherited.
Definition at line 68 of file itkMapContainer.h.
typedef SmartPointer< Self > itk::MapContainer< TElementIdentifier, TElement >::Pointer |
Reimplemented from itk::Object.
Definition at line 53 of file itkMapContainer.h.
typedef MapContainer itk::MapContainer< TElementIdentifier, TElement >::Self |
Standard class typedefs.
Reimplemented from itk::Object.
Definition at line 51 of file itkMapContainer.h.
typedef MapType itk::MapContainer< TElementIdentifier, TElement >::STLContainerType |
This type is provided to adapt this container as an STL container
Definition at line 88 of file itkMapContainer.h.
typedef Object itk::MapContainer< TElementIdentifier, TElement >::Superclass |
Reimplemented from itk::Object.
Definition at line 52 of file itkMapContainer.h.
itk::MapContainer< TElementIdentifier, TElement >::MapContainer | ( | const Self & | ) | [private] |
Save the template parameters.
itk::MapContainer< TElementIdentifier, TElement >::MapContainer | ( | ) | [inline] |
Provide pass-through constructors corresponding to all the STL map constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 77 of file itkMapContainer.h.
itk::MapContainer< TElementIdentifier, TElement >::MapContainer | ( | const MapKeyCompareType & | comp | ) | [inline] |
Provide pass-through constructors corresponding to all the STL map constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 78 of file itkMapContainer.h.
itk::MapContainer< TElementIdentifier, TElement >::MapContainer | ( | TInputIterator | first, |
TInputIterator | last | ||
) | [inline] |
Provide pass-through constructors corresponding to all the STL map constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 81 of file itkMapContainer.h.
itk::MapContainer< TElementIdentifier, TElement >::MapContainer | ( | TInputIterator | first, |
TInputIterator | last, | ||
const MapKeyCompareType & | comp | ||
) | [inline] |
Provide pass-through constructors corresponding to all the STL map constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 83 of file itkMapContainer.h.
ConstIterator itk::MapContainer< TElementIdentifier, TElement >::Begin | ( | void | ) | const |
Get a begin const iterator for the map.
Iterator itk::MapContainer< TElementIdentifier, TElement >::Begin | ( | void | ) |
Get a begin const iterator for the map.
const STLContainerType& itk::MapContainer< TElementIdentifier, TElement >::CastToSTLConstContainer | ( | ) | const [inline] |
Cast the container to a const STL container type
Definition at line 98 of file itkMapContainer.h.
STLContainerType& itk::MapContainer< TElementIdentifier, TElement >::CastToSTLContainer | ( | ) | [inline] |
Cast the container to a STL container type
Definition at line 94 of file itkMapContainer.h.
virtual::itk::LightObject::Pointer itk::MapContainer< TElementIdentifier, TElement >::CreateAnother | ( | void | ) | const [virtual] |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
Element& itk::MapContainer< TElementIdentifier, TElement >::CreateElementAt | ( | ElementIdentifier | ) |
Get a reference to the element at the given index. If the index does not exist, it is created automatically.
It is assumed that the value of the element is modified through the reference.
void itk::MapContainer< TElementIdentifier, TElement >::CreateIndex | ( | ElementIdentifier | ) |
The map will create an entry for a given index through the indexing operator. Whether or not it is created, it will be assigned to the default element.
void itk::MapContainer< TElementIdentifier, TElement >::DeleteIndex | ( | ElementIdentifier | ) |
Delete the entry in the STL map corresponding to the given identifier. If the entry does not exist, nothing happens.
Element& itk::MapContainer< TElementIdentifier, TElement >::ElementAt | ( | ElementIdentifier | ) |
Get a reference to the element at the given index. If the index does not exist, it is created automatically.
It is assumed that the value of the element is modified through the reference.
const Element& itk::MapContainer< TElementIdentifier, TElement >::ElementAt | ( | ElementIdentifier | ) | const |
Get a reference to the element at the given index.
ConstIterator itk::MapContainer< TElementIdentifier, TElement >::End | ( | void | ) | const |
Get an end const iterator for the map.
Iterator itk::MapContainer< TElementIdentifier, TElement >::End | ( | void | ) |
Get an end const iterator for the map.
Element itk::MapContainer< TElementIdentifier, TElement >::GetElement | ( | ElementIdentifier | ) | const |
Get the element at the specified index. There is no check for existence performed.
bool itk::MapContainer< TElementIdentifier, TElement >::GetElementIfIndexExists | ( | ElementIdentifier | , |
Element * | |||
) | const |
If the given index doesn't exist in the map, return false. Otherwise, set the element through the pointer (if it isn't null), and return true.
virtual const char* itk::MapContainer< TElementIdentifier, TElement >::GetNameOfClass | ( | ) | const [virtual] |
Standard part of every itk Object.
Reimplemented from itk::Object.
bool itk::MapContainer< TElementIdentifier, TElement >::IndexExists | ( | ElementIdentifier | ) | const |
Check if the STL map has an entry corresponding to the given index. The count will be either 1 or 0.
void itk::MapContainer< TElementIdentifier, TElement >::Initialize | ( | void | ) |
Tell the container to release any memory it may have allocated and return itself to its initial state.
void itk::MapContainer< TElementIdentifier, TElement >::InsertElement | ( | ElementIdentifier | , |
Element | |||
) |
Set the given index value to the given element. If the index doesn't exist, it is automatically created.
static Pointer itk::MapContainer< TElementIdentifier, TElement >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::Object.
void itk::MapContainer< TElementIdentifier, TElement >::operator= | ( | const Self & | ) | [private] |
Save the template parameters.
Reimplemented from itk::Object.
void itk::MapContainer< 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::MapContainer< TElementIdentifier, TElement >::SetElement | ( | ElementIdentifier | , |
Element | |||
) |
Set the given index value to the given element. If the index doesn't exist, it is automatically created.
ElementIdentifier itk::MapContainer< TElementIdentifier, TElement >::Size | ( | void | ) | const |
Get the number of elements currently stored in the map.
void itk::MapContainer< 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.
friend class ConstIterator [friend] |
Definition at line 151 of file itkMapContainer.h.
friend class Iterator [friend] |
Definition at line 149 of file itkMapContainer.h.