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

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 Member Functions
const STLContainerAdaptor &	operator= (const STLContainerAdaptor &r)=delete
	STLContainerAdaptor (const STLContainerAdaptor &r)=delete

Private Attributes
AdapteeType &	m_AdapteeRef

Member Typedef Documentation

template<typename TContainer>

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

Definition at line 47 of file itkSTLContainerAdaptor.h.

template<typename TContainer>

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

Definition at line 49 of file itkSTLContainerAdaptor.h.

template<typename TContainer>

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

Definition at line 50 of file itkSTLContainerAdaptor.h.

Constructor & Destructor Documentation

template<typename TContainer>

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

privatedelete

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

template<typename TContainer>

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

inline

Definition at line 66 of file itkSTLContainerAdaptor.h.

template<typename TContainer>

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

inline

Definition at line 68 of file itkSTLContainerAdaptor.h.

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

Member Function Documentation

template<typename TContainer>

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

inline

Definition at line 73 of file itkSTLContainerAdaptor.h.

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

template<typename TContainer>

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

privatedelete

Member Data Documentation

template<typename TContainer>

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

private

Definition at line 54 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