ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::STLContainerAdaptor< TContainer > Class Template Reference

#include <itkSTLContainerAdaptor.h>

Public Types

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

Public Member Functions

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

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:

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

◆ AdapteeType

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

Definition at line 48 of file itkSTLContainerAdaptor.h.

◆ ElementType

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

Definition at line 50 of file itkSTLContainerAdaptor.h.

◆ TargetType

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

Definition at line 51 of file itkSTLContainerAdaptor.h.

Constructor & Destructor Documentation

◆ STLContainerAdaptor() [1/2]

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

Definition at line 57 of file itkSTLContainerAdaptor.h.

◆ STLContainerAdaptor() [2/2]

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

Definition at line 61 of file itkSTLContainerAdaptor.h.

◆ ~STLContainerAdaptor()

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

Member Function Documentation

◆ GetSTLContainerRef()

template<typename TContainer>
TargetType& itk::STLContainerAdaptor< TContainer >::GetSTLContainerRef ( )
inline

Member Data Documentation

◆ m_AdapteeRef

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

The documentation for this class was generated from the following file:
itk::STLContainerAdaptor
An adapter object that casts a itk::XxxContainer into std::xxx and enables access to the underlying d...
Definition: itkSTLContainerAdaptor.h:43