ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Member Functions | Private Attributes
itk::STLContainerAdaptor< TContainer > Class Template Reference

#include <itkSTLContainerAdaptor.h>

List of all members.

Public Types

typedef TContainer AdapteeType
typedef AdapteeType::Element ElementType
typedef
AdapteeType::STLContainerType 
TargetType

Public Member Functions

TargetTypeGetSTLContainerRef ()
 STLContainerAdaptor (AdapteeType &adaptee)
 STLContainerAdaptor (AdapteeType *adaptee)
 ~STLContainerAdaptor ()

Private Member Functions

const STLContainerAdaptoroperator= (const STLContainerAdaptor &r)
 STLContainerAdaptor (const STLContainerAdaptor &r)

Private Attributes

AdapteeTypem_AdapteeRef

Detailed Description

template<typename TContainer>
class itk::STLContainerAdaptor< TContainer >

An adapter object that casts a itk::XxxContainer into std::xxx and enables access to the underlying data structure.

When the STLContainerAdaptor is destroyed, it automatically calls XxxContainer::Modified().

Here's a usage example of STLContainerAdaptor:

     itk::STLContainerAdaptor<itk::VectorContainer<size_t, ElementType>> vecAdaptor(aContainer);
     std::vector<ElementType> & vec = vecAdaptor.GetSTLContainerRef();
     // do things with vec ...
     // upon return from function, vecAdaptor is destroyed and aContainer is Modified()

Definition at line 43 of file itkSTLContainerAdaptor.h.


Member Typedef Documentation

template<typename TContainer>
typedef TContainer itk::STLContainerAdaptor< TContainer >::AdapteeType

Definition at line 47 of file itkSTLContainerAdaptor.h.

template<typename TContainer>
typedef AdapteeType::Element itk::STLContainerAdaptor< TContainer >::ElementType

Definition at line 49 of file itkSTLContainerAdaptor.h.

template<typename TContainer>
typedef AdapteeType::STLContainerType itk::STLContainerAdaptor< TContainer >::TargetType

Definition at line 50 of file itkSTLContainerAdaptor.h.


Constructor & Destructor Documentation

template<typename TContainer>
itk::STLContainerAdaptor< TContainer >::STLContainerAdaptor ( const STLContainerAdaptor< TContainer > &  r) [private]

hide the copy constructor to allow only direct construction of the adapter

template<typename TContainer>
itk::STLContainerAdaptor< TContainer >::STLContainerAdaptor ( AdapteeType adaptee) [inline]

Definition at line 63 of file itkSTLContainerAdaptor.h.

template<typename TContainer>
itk::STLContainerAdaptor< TContainer >::STLContainerAdaptor ( AdapteeType adaptee) [inline]

Definition at line 65 of file itkSTLContainerAdaptor.h.

template<typename TContainer>
itk::STLContainerAdaptor< TContainer >::~STLContainerAdaptor ( ) [inline]

Member Function Documentation

template<typename TContainer>
TargetType& itk::STLContainerAdaptor< TContainer >::GetSTLContainerRef ( ) [inline]
template<typename TContainer>
const STLContainerAdaptor& itk::STLContainerAdaptor< TContainer >::operator= ( const STLContainerAdaptor< TContainer > &  r) [private]

Member Data Documentation

template<typename TContainer>
AdapteeType& itk::STLContainerAdaptor< TContainer >::m_AdapteeRef [private]

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