itk::STLContainerAdaptor< TContainer > Class Template Reference

#include <itkSTLContainerAdaptor.h>

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<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 45 of file itkSTLContainerAdaptor.h.

Public Types
using	AdapteeType = TContainer
using	ElementType = typename AdapteeType::Element
using	TargetType = typename AdapteeType::STLContainerType

Public Member Functions
TargetType &	GetSTLContainerRef ()
	STLContainerAdaptor (AdapteeType &adaptee)
	STLContainerAdaptor (AdapteeType *adaptee)
	~STLContainerAdaptor ()

Private Attributes
AdapteeType &	m_AdapteeRef

Member Typedef Documentation

AdapteeType

template<typename TContainer >

using itk::STLContainerAdaptor< TContainer >::AdapteeType = TContainer

Definition at line 50 of file itkSTLContainerAdaptor.h.

ElementType

template<typename TContainer >

using itk::STLContainerAdaptor< TContainer >::ElementType = typename AdapteeType::Element

Definition at line 52 of file itkSTLContainerAdaptor.h.

TargetType

template<typename TContainer >

using itk::STLContainerAdaptor< TContainer >::TargetType = typename AdapteeType::STLContainerType

Definition at line 53 of file itkSTLContainerAdaptor.h.

Constructor & Destructor Documentation

STLContainerAdaptor() [1/2]

template<typename TContainer >

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

inline

Definition at line 59 of file itkSTLContainerAdaptor.h.

STLContainerAdaptor() [2/2]

template<typename TContainer >

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

inline

Definition at line 63 of file itkSTLContainerAdaptor.h.

~STLContainerAdaptor()

template<typename TContainer >

itk::STLContainerAdaptor< TContainer >::~STLContainerAdaptor ( )

inline

Definition at line 67 of file itkSTLContainerAdaptor.h.

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

Member Function Documentation

GetSTLContainerRef()

template<typename TContainer >

TargetType & itk::STLContainerAdaptor< TContainer >::GetSTLContainerRef ( )

inline

Definition at line 70 of file itkSTLContainerAdaptor.h.

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

Member Data Documentation

m_AdapteeRef

template<typename TContainer >

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

private

Definition at line 56 of file itkSTLContainerAdaptor.h.

Referenced by itk::STLContainerAdaptor< TContainer >::GetSTLContainerRef(), and itk::STLContainerAdaptor< TContainer >::~STLContainerAdaptor().

---

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

• itkSTLContainerAdaptor.h