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

#include <itkVectorContainer.h>

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

[legend]Collaboration diagram for itk::VectorContainer< TElementIdentifier, TElement >:

[legend]List of all members.

Public Types
typedef VectorContainer	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TElementIdentifier	ElementIdentifier
typedef TElement	Element
typedef VectorType	STLContainerType
Public Member Functions
virtual const char *	GetNameOfClass () const
STLContainerType &	CastToSTLContainer ()
const STLContainerType &	CastToSTLConstContainer () const
Element &	ElementAt (ElementIdentifier)
const Element &	ElementAt (ElementIdentifier) const
Element &	CreateElementAt (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 ()
Protected Member Functions
	VectorContainer ()
	VectorContainer (size_type n)
	VectorContainer (size_type n, const Element &x)
	VectorContainer (const Self &r)
template<typename InputIterator>	VectorContainer (InputIterator first, InputIterator last)
Friends
class	Iterator
class	ConstIterator

---

Detailed Description

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

Define a front-end to the STL "vector" container that conforms to the IndexedContainerInterface. This is a full-fleged Object, so there is modification time, debug, and reference count information.

Template parameters for VectorContainer:

TElementIdentifier = An INTEGRAL type for use in indexing the vector.

TElement = The element type stored in the container.

Definition at line 48 of file itkVectorContainer.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object. Definition at line 57 of file itkVectorContainer.h.

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

Definition at line 61 of file itkVectorContainer.h. Referenced by itk::VectorContainer< TElementIdentifier, TElement >::ConstIterator::Index(), and itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer().

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

Save the template parameters. Definition at line 60 of file itkVectorContainer.h. Referenced by itk::VectorContainer< TElementIdentifier, TElement >::ConstIterator::operator!=(), and itk::VectorContainer< TElementIdentifier, TElement >::Iterator::operator==().

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

Reimplemented from itk::Object. Definition at line 56 of file itkVectorContainer.h.

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

Standard class typedefs. Reimplemented from itk::Object. Definition at line 54 of file itkVectorContainer.h. Referenced by itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer().

template<typename TElementIdentifier, typename TElement> typedef VectorType itk::VectorContainer< TElementIdentifier, TElement >::STLContainerType

This type is provided to Adapt this container as an STL container Definition at line 90 of file itkVectorContainer.h.

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

Reimplemented from itk::Object. Definition at line 55 of file itkVectorContainer.h.

---

Constructor & Destructor Documentation

template<typename TElementIdentifier, typename TElement> itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer (   )  [inline, protected]

Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine. Definition at line 74 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement> itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer (  size_type  n  )  [inline, protected]

Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine. Definition at line 76 of file itkVectorContainer.h.

template<typename TElementIdentifier, typename TElement> itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer (  size_type  n, const Element &  x )  [inline, protected]

Provide pass-through constructors corresponding to all the STL vector 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 itkVectorContainer.h. References itk::VectorContainer< TElementIdentifier, TElement >::Element.

template<typename TElementIdentifier, typename TElement> itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer (  const Self &  r  )  [inline, protected]

Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine. Definition at line 80 of file itkVectorContainer.h. References itk::VectorContainer< TElementIdentifier, TElement >::Self.

template<typename TElementIdentifier, typename TElement> template<typename InputIterator> itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer (  InputIterator  first, InputIterator  last )  [inline, protected]

Provide pass-through constructors corresponding to all the STL vector 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 itkVectorContainer.h.

---

Member Function Documentation

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

Declare the public interface routines.

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

Declare the public interface routines.

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

Cast the container to a const STL container type Definition at line 107 of file itkVectorContainer.h.

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

Cast the container to a STL container type Definition at line 103 of file itkVectorContainer.h.

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

Declare the public interface routines.

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

Declare the public interface routines.

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

Declare the public interface routines.

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

Declare the public interface routines.

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

Declare the public interface routines.

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

Declare the public interface routines.

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

Declare the public interface routines.

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

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement> bool itk::VectorContainer< TElementIdentifier, TElement >::GetElementIfIndexExists (  ElementIdentifier  , Element *  )  const

Declare the public interface routines.

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

Standard part of every itk Object. Reimplemented from itk::Object.

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

Declare the public interface routines.

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

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement> void itk::VectorContainer< TElementIdentifier, TElement >::InsertElement (  ElementIdentifier  , Element  )

Declare the public interface routines.

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

Method for creation through the object factory. Reimplemented from itk::Object.

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

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement> void itk::VectorContainer< TElementIdentifier, TElement >::SetElement (  ElementIdentifier  , Element  )

Declare the public interface routines.

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

Declare the public interface routines.

template<typename TElementIdentifier, typename TElement> void itk::VectorContainer< 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 112 of file itkVectorContainer.h.

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

Friends to this class. Definition at line 111 of file itkVectorContainer.h.

---

The documentation for this class was generated from the following file:

• itkVectorContainer.h

---