Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::MapContainer< TElementIdentifier, TElement > Class Template Reference
[Data Representation Objects]

#include <itkMapContainer.h>

Inheritance diagram for itk::MapContainer< TElementIdentifier, TElement >:

Inheritance graph
[legend]
Collaboration diagram for itk::MapContainer< TElementIdentifier, TElement >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef MapContainer Self
typedef Object Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TElementIdentifier ElementIdentifier
typedef TElement Element
typedef MapType STLContainerType

Public Member Functions

virtual const char * GetNameOfClass () const
STLContainerTypeCastToSTLContainer ()
const STLContainerTypeCastToSTLConstContainer () const
 MapContainer ()
 MapContainer (const MapKeyCompareType &comp)
template<typename InputIterator>  MapContainer (InputIterator first, InputIterator last)
template<typename InputIterator>  MapContainer (InputIterator first, InputIterator last, const MapKeyCompareType &comp)
ElementElementAt (ElementIdentifier)
const ElementElementAt (ElementIdentifier) const
ElementCreateElementAt (ElementIdentifier)
Element GetElement (ElementIdentifier) const
void SetElement (ElementIdentifier, Element)
void InsertElement (ElementIdentifier, Element)
bool IndexExists (ElementIdentifier) const
bool GetElementIfIndexExists (ElementIdentifier, Element *) const
void CreateIndex (ElementIdentifier)
void DeleteIndex (ElementIdentifier)
ConstIterator Begin (void) const
ConstIterator End (void) const
Iterator Begin (void)
Iterator End (void)
unsigned long Size (void) const
void Reserve (ElementIdentifier)
void Squeeze (void)
void Initialize (void)

Static Public Member Functions

Pointer New ()

Friends

class Iterator
class ConstIterator

Detailed Description

template<typename TElementIdentifier, typename TElement>
class itk::MapContainer< TElementIdentifier, TElement >

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.

Template parameters for MapContainer:

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 46 of file itkMapContainer.h.


Member Typedef Documentation

template<typename TElementIdentifier, typename TElement>
typedef SmartPointer<const Self> itk::MapContainer< TElementIdentifier, TElement >::ConstPointer
 

Reimplemented from itk::Object.

Definition at line 55 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
typedef TElement itk::MapContainer< TElementIdentifier, TElement >::Element
 

Definition at line 62 of file itkMapContainer.h.

Referenced by itk::MapContainer< TElementIdentifier, TElement >::ConstIterator::Index(), and itk::MapContainer< TElementIdentifier, TElement >::Iterator::Index().

template<typename TElementIdentifier, typename TElement>
typedef TElementIdentifier itk::MapContainer< TElementIdentifier, TElement >::ElementIdentifier
 

Save the template parameters.

Definition at line 61 of file itkMapContainer.h.

Referenced by itk::MapContainer< TElementIdentifier, TElement >::ConstIterator::operator!=(), and itk::MapContainer< TElementIdentifier, TElement >::Iterator::operator!=().

template<typename TElementIdentifier, typename TElement>
typedef SmartPointer<Self> itk::MapContainer< TElementIdentifier, TElement >::Pointer
 

Reimplemented from itk::Object.

Definition at line 54 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
typedef MapContainer itk::MapContainer< TElementIdentifier, TElement >::Self
 

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 52 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
typedef MapType itk::MapContainer< TElementIdentifier, TElement >::STLContainerType
 

This type is provided to Adapt this container as an STL container

Definition at line 92 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
typedef Object itk::MapContainer< TElementIdentifier, TElement >::Superclass
 

Reimplemented from itk::Object.

Definition at line 53 of file itkMapContainer.h.


Constructor & Destructor Documentation

template<typename TElementIdentifier, typename TElement>
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 78 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
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 79 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
template<typename InputIterator>
itk::MapContainer< TElementIdentifier, TElement >::MapContainer InputIterator  first,
InputIterator  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 82 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
template<typename InputIterator>
itk::MapContainer< TElementIdentifier, TElement >::MapContainer InputIterator  first,
InputIterator  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 84 of file itkMapContainer.h.


Member Function Documentation

template<typename TElementIdentifier, typename TElement>
Iterator itk::MapContainer< TElementIdentifier, TElement >::Begin void   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
ConstIterator itk::MapContainer< TElementIdentifier, TElement >::Begin void   )  const
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
const STLContainerType& itk::MapContainer< TElementIdentifier, TElement >::CastToSTLConstContainer  )  const [inline]
 

Cast the container to a const STL container type

Definition at line 99 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
STLContainerType& itk::MapContainer< TElementIdentifier, TElement >::CastToSTLContainer  )  [inline]
 

Cast the container to a STL container type

Definition at line 95 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
Element& itk::MapContainer< TElementIdentifier, TElement >::CreateElementAt ElementIdentifier   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
void itk::MapContainer< TElementIdentifier, TElement >::CreateIndex ElementIdentifier   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
void itk::MapContainer< TElementIdentifier, TElement >::DeleteIndex ElementIdentifier   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
const Element& itk::MapContainer< TElementIdentifier, TElement >::ElementAt ElementIdentifier   )  const
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
Element& itk::MapContainer< TElementIdentifier, TElement >::ElementAt ElementIdentifier   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
Iterator itk::MapContainer< TElementIdentifier, TElement >::End void   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
ConstIterator itk::MapContainer< TElementIdentifier, TElement >::End void   )  const
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
Element itk::MapContainer< TElementIdentifier, TElement >::GetElement ElementIdentifier   )  const
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
bool itk::MapContainer< TElementIdentifier, TElement >::GetElementIfIndexExists ElementIdentifier  ,
Element
const
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
virtual const char* itk::MapContainer< TElementIdentifier, TElement >::GetNameOfClass  )  const [virtual]
 

Standard part of every itk Object.

Reimplemented from itk::Object.

template<typename TElementIdentifier, typename TElement>
bool itk::MapContainer< TElementIdentifier, TElement >::IndexExists ElementIdentifier   )  const
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
void itk::MapContainer< TElementIdentifier, TElement >::Initialize void   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
void itk::MapContainer< TElementIdentifier, TElement >::InsertElement ElementIdentifier  ,
Element 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
Pointer itk::MapContainer< TElementIdentifier, TElement >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TElementIdentifier, typename TElement>
void itk::MapContainer< TElementIdentifier, TElement >::Reserve ElementIdentifier   ) 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
void itk::MapContainer< TElementIdentifier, TElement >::SetElement ElementIdentifier  ,
Element 
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
unsigned long itk::MapContainer< TElementIdentifier, TElement >::Size void   )  const
 

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement>
void itk::MapContainer< TElementIdentifier, TElement >::Squeeze void   ) 
 

Declare the public interface routines.


Friends And Related Function Documentation

template<typename TElementIdentifier, typename TElement>
friend class ConstIterator [friend]
 

Definition at line 106 of file itkMapContainer.h.

template<typename TElementIdentifier, typename TElement>
friend class Iterator [friend]
 

Definition at line 105 of file itkMapContainer.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:42:05 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000