ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
itk::CorrespondenceDataStructureIterator< TStructureType > Class Template Reference

#include <itkCorrespondenceDataStructureIterator.h>

Detailed Description

template<typename TStructureType>
class itk::CorrespondenceDataStructureIterator< TStructureType >

An iterator designed to easily traverse an CorrespondenceDataStructure.

Definition at line 32 of file itkCorrespondenceDataStructureIterator.h.

Public Types

using CorrespondingListIterator = typename CorrespondingListType::iterator
 
using CorrespondingListType = typename TStructureType::CorrespondingListType
 
using ItemType = typename TStructureType::ItemType
 
using NodeListIterator = typename NodeListType::iterator
 
using NodeListType = typename TStructureType::NodeListType
 
using SecondaryNodeListIterator = typename SecondaryNodeListType::iterator
 
using SecondaryNodeListType = typename TStructureType::SecondaryNodeListType
 
using Self = CorrespondenceDataStructureIterator
 

Public Member Functions

 CorrespondenceDataStructureIterator (TStructureType *StructurePtr)
 
CorrespondingListTypeGetCorrespondingListPointer ()
 
void GoToNext ()
 
void GoToNextBaseGroup ()
 
bool IsAtEnd () const
 
void operator++ ()
 
void operator++ (int)
 
void Reset ()
 
virtual ~CorrespondenceDataStructureIterator ()=default
 

Static Public Member Functions

static unsigned int GetIteratorDimension ()
 

Public Attributes

CorrespondingListIterator m_CorrespondingListIterator {}
 
TStructureType::NodeListType::iterator m_NodeListIterator {}
 
SecondaryNodeListIterator m_SecondaryListIterator {}
 

Protected Attributes

CorrespondingListTypem_CorrespondingListPointer {}
 
ItemTypem_CorrespondingNodePointer {}
 
bool m_IsAtEnd {}
 
NodeListTypem_NodeListPointer {}
 
SecondaryNodeListTypem_SecondaryListPointer {}
 
TStructureType * m_Structure {}
 

Member Typedef Documentation

◆ CorrespondingListIterator

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::CorrespondingListIterator = typename CorrespondingListType::iterator

Definition at line 87 of file itkCorrespondenceDataStructureIterator.h.

◆ CorrespondingListType

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::CorrespondingListType = typename TStructureType::CorrespondingListType

Definition at line 82 of file itkCorrespondenceDataStructureIterator.h.

◆ ItemType

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::ItemType = typename TStructureType::ItemType

Definition at line 83 of file itkCorrespondenceDataStructureIterator.h.

◆ NodeListIterator

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::NodeListIterator = typename NodeListType::iterator

Definition at line 89 of file itkCorrespondenceDataStructureIterator.h.

◆ NodeListType

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::NodeListType = typename TStructureType::NodeListType

Definition at line 85 of file itkCorrespondenceDataStructureIterator.h.

◆ SecondaryNodeListIterator

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::SecondaryNodeListIterator = typename SecondaryNodeListType::iterator

Definition at line 88 of file itkCorrespondenceDataStructureIterator.h.

◆ SecondaryNodeListType

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::SecondaryNodeListType = typename TStructureType::SecondaryNodeListType

Definition at line 84 of file itkCorrespondenceDataStructureIterator.h.

◆ Self

template<typename TStructureType >
using itk::CorrespondenceDataStructureIterator< TStructureType >::Self = CorrespondenceDataStructureIterator

Standard class type aliases.

Definition at line 36 of file itkCorrespondenceDataStructureIterator.h.

Constructor & Destructor Documentation

◆ CorrespondenceDataStructureIterator()

template<typename TStructureType >
itk::CorrespondenceDataStructureIterator< TStructureType >::CorrespondenceDataStructureIterator ( TStructureType *  StructurePtr)

Constructor

◆ ~CorrespondenceDataStructureIterator()

template<typename TStructureType >
virtual itk::CorrespondenceDataStructureIterator< TStructureType >::~CorrespondenceDataStructureIterator ( )
virtualdefault

Destructor

Member Function Documentation

◆ GetCorrespondingListPointer()

template<typename TStructureType >
CorrespondingListType* itk::CorrespondenceDataStructureIterator< TStructureType >::GetCorrespondingListPointer ( )
inline

Get m_CorrespondingListPointer.

Definition at line 93 of file itkCorrespondenceDataStructureIterator.h.

◆ GetIteratorDimension()

template<typename TStructureType >
static unsigned int itk::CorrespondenceDataStructureIterator< TStructureType >::GetIteratorDimension ( )
inlinestatic

Get the dimension (size) of the index.

Definition at line 40 of file itkCorrespondenceDataStructureIterator.h.

◆ GoToNext()

template<typename TStructureType >
void itk::CorrespondenceDataStructureIterator< TStructureType >::GoToNext ( )

Goes to the next corresponding node clique in the structure, moving on to the next base node clique if necessary.

◆ GoToNextBaseGroup()

template<typename TStructureType >
void itk::CorrespondenceDataStructureIterator< TStructureType >::GoToNextBaseGroup ( )

Goes to the next base node clique.

◆ IsAtEnd()

template<typename TStructureType >
bool itk::CorrespondenceDataStructureIterator< TStructureType >::IsAtEnd ( ) const

Is the iterator at the end of the region?

◆ operator++() [1/2]

template<typename TStructureType >
void itk::CorrespondenceDataStructureIterator< TStructureType >::operator++ ( )
inline

Walk forward one index. (prefix)

Definition at line 51 of file itkCorrespondenceDataStructureIterator.h.

◆ operator++() [2/2]

template<typename TStructureType >
void itk::CorrespondenceDataStructureIterator< TStructureType >::operator++ ( int  )
inline

Walk forward one index. (postfix)

Definition at line 58 of file itkCorrespondenceDataStructureIterator.h.

◆ Reset()

template<typename TStructureType >
void itk::CorrespondenceDataStructureIterator< TStructureType >::Reset ( )

Resets the iterator.

Member Data Documentation

◆ m_CorrespondingListIterator

template<typename TStructureType >
CorrespondingListIterator itk::CorrespondenceDataStructureIterator< TStructureType >::m_CorrespondingListIterator {}

Definition at line 98 of file itkCorrespondenceDataStructureIterator.h.

◆ m_CorrespondingListPointer

template<typename TStructureType >
CorrespondingListType* itk::CorrespondenceDataStructureIterator< TStructureType >::m_CorrespondingListPointer {}
protected

Definition at line 108 of file itkCorrespondenceDataStructureIterator.h.

◆ m_CorrespondingNodePointer

template<typename TStructureType >
ItemType* itk::CorrespondenceDataStructureIterator< TStructureType >::m_CorrespondingNodePointer {}
protected

Definition at line 107 of file itkCorrespondenceDataStructureIterator.h.

◆ m_IsAtEnd

template<typename TStructureType >
bool itk::CorrespondenceDataStructureIterator< TStructureType >::m_IsAtEnd {}
protected

Is the iterator at the end of its walk?

Definition at line 105 of file itkCorrespondenceDataStructureIterator.h.

◆ m_NodeListIterator

template<typename TStructureType >
TStructureType::NodeListType::iterator itk::CorrespondenceDataStructureIterator< TStructureType >::m_NodeListIterator {}

Definition at line 101 of file itkCorrespondenceDataStructureIterator.h.

◆ m_NodeListPointer

template<typename TStructureType >
NodeListType* itk::CorrespondenceDataStructureIterator< TStructureType >::m_NodeListPointer {}
protected

Definition at line 110 of file itkCorrespondenceDataStructureIterator.h.

◆ m_SecondaryListIterator

template<typename TStructureType >
SecondaryNodeListIterator itk::CorrespondenceDataStructureIterator< TStructureType >::m_SecondaryListIterator {}

Definition at line 99 of file itkCorrespondenceDataStructureIterator.h.

◆ m_SecondaryListPointer

template<typename TStructureType >
SecondaryNodeListType* itk::CorrespondenceDataStructureIterator< TStructureType >::m_SecondaryListPointer {}
protected

Definition at line 109 of file itkCorrespondenceDataStructureIterator.h.

◆ m_Structure

template<typename TStructureType >
TStructureType* itk::CorrespondenceDataStructureIterator< TStructureType >::m_Structure {}
protected

Definition at line 106 of file itkCorrespondenceDataStructureIterator.h.


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