itk::STLConstContainerAdaptor< TContainer > Class Template Reference

#include <itkSTLConstContainerAdaptor.h>

Detailed Description

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

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

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

The class is provided for interface consistency with STLContainerAdaptor plus the [const] modifier. Since everything is const, there is no need to call AdapteeType::Modified() in the destructor.

Here's a usage example of STLContainerAdaptor

*     itk::STLConstContainerAdaptor<itk::VectorContainer<SizeValueType, ElementType>> vecAdaptor(aContainer);
*     const std::vector<ElementType> & vec = vecAdaptor.GetSTLContainerRef();
*     // do things with vec ...
* 

Definition at line 46 of file itkSTLConstContainerAdaptor.h.

Public Types
typedef const TContainer	AdapteeType
typedef const AdapteeType::Element	ElementType
typedef const AdapteeType::STLContainerType	TargetType

Public Member Functions
TargetType &	GetSTLConstContainerRef ()
	STLConstContainerAdaptor (AdapteeType &adaptee)
	STLConstContainerAdaptor (AdapteeType *adaptee)

Private Member Functions
const STLConstContainerAdaptor &	operator= (const STLConstContainerAdaptor &r)
	STLConstContainerAdaptor (const STLConstContainerAdaptor &r)

Private Attributes
AdapteeType &	m_AdapteeRef

Member Typedef Documentation

template<typename TContainer>

typedef const TContainer itk::STLConstContainerAdaptor< TContainer >::AdapteeType

Definition at line 50 of file itkSTLConstContainerAdaptor.h.

template<typename TContainer>

typedef const AdapteeType::Element itk::STLConstContainerAdaptor< TContainer >::ElementType

Definition at line 52 of file itkSTLConstContainerAdaptor.h.

template<typename TContainer>

typedef const AdapteeType::STLContainerType itk::STLConstContainerAdaptor< TContainer >::TargetType

Definition at line 53 of file itkSTLConstContainerAdaptor.h.

Constructor & Destructor Documentation

template<typename TContainer>

itk::STLConstContainerAdaptor< TContainer >::STLConstContainerAdaptor ( const STLConstContainerAdaptor< TContainer > &  r )

private

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

template<typename TContainer>

itk::STLConstContainerAdaptor< TContainer >::STLConstContainerAdaptor ( AdapteeType &  adaptee )

inline

Definition at line 68 of file itkSTLConstContainerAdaptor.h.

template<typename TContainer>

itk::STLConstContainerAdaptor< TContainer >::STLConstContainerAdaptor ( AdapteeType *  adaptee )

inline

Definition at line 70 of file itkSTLConstContainerAdaptor.h.

Member Function Documentation

template<typename TContainer>

TargetType& itk::STLConstContainerAdaptor< TContainer >::GetSTLConstContainerRef ( )

inline

Definition at line 72 of file itkSTLConstContainerAdaptor.h.

References itk::STLConstContainerAdaptor< TContainer >::m_AdapteeRef.

template<typename TContainer>

const STLConstContainerAdaptor& itk::STLConstContainerAdaptor< TContainer >::operator= ( const STLConstContainerAdaptor< TContainer > &  r )

private

Member Data Documentation

template<typename TContainer>

AdapteeType& itk::STLConstContainerAdaptor< TContainer >::m_AdapteeRef

private

Definition at line 57 of file itkSTLConstContainerAdaptor.h.

Referenced by itk::STLConstContainerAdaptor< TContainer >::GetSTLConstContainerRef().

---

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

• itkSTLConstContainerAdaptor.h