#include <itkIndexedContainerInterface.h>

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

Collaboration diagram for itk::IndexedContainerInterface< TElementIdentifier, TElement >:

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. 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

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.

Classes
class	ConstIterator

class	Iterator

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef TElement	Element

typedef TElementIdentifier	ElementIdentifier

typedef SmartPointer< Self >	Pointer

typedef IndexedContainerInterface	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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)

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual LightObject::Pointer	CreateAnother () const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock