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

itk::ImageContainerInterface< TElementIdentifier, TElement > Class Template Reference
[Image Representation Objects]

#include <itkImageContainerInterface.h>

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

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef ImageContainerInterface Self
typedef Object Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TElementIdentifier ElementIdentifier
typedef TElement Element

Public Member Functions

virtual const char * GetNameOfClass () const
virtual TElement & operator[] (const ElementIdentifier)=0
virtual const TElement & operator[] (const ElementIdentifier) const=0
virtual TElement * GetBufferPointer ()=0
virtual unsigned long Size (void) const=0
virtual void Reserve (ElementIdentifier)=0
virtual void Squeeze (void)=0

Detailed Description

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

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 for ImageContainerInterface:

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


Member Typedef Documentation

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

Reimplemented from itk::Object.

Definition at line 60 of file itkImageContainerInterface.h.

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

Definition at line 67 of file itkImageContainerInterface.h.

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

Save the template parameters.

Definition at line 66 of file itkImageContainerInterface.h.

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

Reimplemented from itk::Object.

Definition at line 59 of file itkImageContainerInterface.h.

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

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 57 of file itkImageContainerInterface.h.

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

Reimplemented from itk::Object.

Definition at line 58 of file itkImageContainerInterface.h.


Member Function Documentation

template<typename TElementIdentifier, typename TElement>
virtual TElement* itk::ImageContainerInterface< TElementIdentifier, TElement >::GetBufferPointer  )  [pure virtual]
 

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

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

Standard part of every itk Object.

Reimplemented from itk::Object.

template<typename TElementIdentifier, typename TElement>
virtual const TElement& itk::ImageContainerInterface< TElementIdentifier, TElement >::operator[] const  ElementIdentifier  )  const [pure virtual]
 

Index operator. This version can only be an rvalue

template<typename TElementIdentifier, typename TElement>
virtual TElement& itk::ImageContainerInterface< TElementIdentifier, TElement >::operator[] const  ElementIdentifier  )  [pure virtual]
 

Index operator. This version can be an lvalue.

template<typename TElementIdentifier, typename TElement>
virtual void itk::ImageContainerInterface< TElementIdentifier, TElement >::Reserve ElementIdentifier   )  [pure virtual]
 

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.

template<typename TElementIdentifier, typename TElement>
virtual unsigned long itk::ImageContainerInterface< TElementIdentifier, TElement >::Size void   )  const [pure virtual]
 

Get the number of elements currently stored in the container.

template<typename TElementIdentifier, typename TElement>
virtual void itk::ImageContainerInterface< TElementIdentifier, TElement >::Squeeze void   )  [pure virtual]
 

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.


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