ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Friends | List of all members
itk::PreOrderTreeIterator< TTreeType > Class Template Reference

#include <itkPreOrderTreeIterator.h>

+ Inheritance diagram for itk::PreOrderTreeIterator< TTreeType >:
+ Collaboration diagram for itk::PreOrderTreeIterator< TTreeType >:

Public Types

using NodeType = typename Superclass::NodeType
 
using Superclass = TreeIteratorBase< TTreeType >
 
using TreeNodeType = typename Superclass::TreeNodeType
 
using ValueType = typename TTreeType::ValueType
 
- Public Types inherited from itk::TreeIteratorBase< TTreeType >
using ChildIdentifier = typename TreeNodeType::ChildIdentifier
 
using NodeType = TreeIteratorBaseNodeEnum
 
using Self = TreeIteratorBase
 
using TreeNodeType = typename TTreeType::TreeNodeType
 
using ValueType = typename TTreeType::ValueType
 

Public Member Functions

NodeType GetType () const override
 
 PreOrderTreeIterator (const TTreeType *tree, const TreeNodeType *start=nullptr)
 
- Public Member Functions inherited from itk::TreeIteratorBase< TTreeType >
virtual bool Add (int position, ValueType element)
 
virtual bool Add (TTreeType &subTree)
 
virtual bool Add (ValueType element)
 
virtual int ChildPosition (ValueType element) const
 
virtual TreeIteratorBase< TTreeType > * Children ()
 
virtual int Count ()
 
virtual int CountChildren () const
 
virtual bool Disconnect ()
 
virtual const ValueTypeGet () const
 
virtual TreeIteratorBase< TTreeType > * GetChild (int number) const
 
virtual TreeNodeTypeGetNode ()
 
virtual const TreeNodeTypeGetNode () const
 
const TreeNodeTypeGetParent () const
 
TreeNodeTypeGetRoot ()
 
const TreeNodeTypeGetRoot () const
 
virtual TTreeType * GetSubTree () const
 
TTreeType * GetTree () const
 
void GoToBegin ()
 
virtual bool GoToChild (ChildIdentifier number=0)
 
void GoToEnd ()
 
virtual bool GoToParent ()
 
virtual bool HasChild (int number=0) const
 
virtual bool HasParent () const
 
bool IsAtBegin () const
 
bool IsAtEnd () const
 
virtual bool IsLeaf () const
 
virtual bool IsRoot () const
 
virtual TreeIteratorBase< TTreeType > * Parents ()
 
bool Remove ()
 
virtual bool RemoveChild (int number)
 
void Set (ValueType element)
 
Selfoperator++ ()
 
void operator++ (int)
 
Selfoperator= (const Self &iterator)
 
virtual ~TreeIteratorBase ()=default
 

Friends

class LeafTreeIterator< TTreeType >
 
TreeIteratorBase< TTreeType > * Clone () override
 
const ValueTypeNext () override
 
bool HasNext () const override
 
const TreeNodeTypeFindNextNode () const
 

Additional Inherited Members

- Protected Member Functions inherited from itk::TreeIteratorBase< TTreeType >
 TreeIteratorBase (TTreeType *tree, const TreeNodeType *start)
 
 TreeIteratorBase (const TTreeType *tree, const TreeNodeType *start)
 
- Protected Attributes inherited from itk::TreeIteratorBase< TTreeType >
TreeNodeTypem_Position
 
TreeNodeTypem_Begin
 
const TreeNodeTypem_Root
 
TTreeType * m_Tree
 

Detailed Description

template<typename TTreeType>
class itk::PreOrderTreeIterator< TTreeType >

Examples
Examples/DataRepresentation/Containers/TreeContainer.cxx.

Definition at line 30 of file itkPreOrderTreeIterator.h.

Member Typedef Documentation

◆ NodeType

template<typename TTreeType>
using itk::PreOrderTreeIterator< TTreeType >::NodeType = typename Superclass::NodeType

Definition at line 37 of file itkPreOrderTreeIterator.h.

◆ Superclass

template<typename TTreeType>
using itk::PreOrderTreeIterator< TTreeType >::Superclass = TreeIteratorBase<TTreeType>

Definition at line 35 of file itkPreOrderTreeIterator.h.

◆ TreeNodeType

template<typename TTreeType>
using itk::PreOrderTreeIterator< TTreeType >::TreeNodeType = typename Superclass::TreeNodeType

Definition at line 36 of file itkPreOrderTreeIterator.h.

◆ ValueType

template<typename TTreeType>
using itk::PreOrderTreeIterator< TTreeType >::ValueType = typename TTreeType::ValueType

Typedefs

Definition at line 34 of file itkPreOrderTreeIterator.h.

Constructor & Destructor Documentation

◆ PreOrderTreeIterator()

template<typename TTreeType >
itk::PreOrderTreeIterator< TTreeType >::PreOrderTreeIterator ( const TTreeType *  tree,
const TreeNodeType start = nullptr 
)

Constructor

Definition at line 72 of file itkPreOrderTreeIterator.h.

Member Function Documentation

◆ Clone()

template<typename TTreeType >
TreeIteratorBase< TTreeType > * itk::PreOrderTreeIterator< TTreeType >::Clone ( )
overridevirtual

Clone function

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 165 of file itkPreOrderTreeIterator.h.

◆ FindNextNode()

template<typename TTreeType >
const PreOrderTreeIterator< TTreeType >::TreeNodeType * itk::PreOrderTreeIterator< TTreeType >::FindNextNode ( ) const
private

Find the next node

Definition at line 114 of file itkPreOrderTreeIterator.h.

◆ GetType()

template<typename TTreeType >
PreOrderTreeIterator< TTreeType >::NodeType itk::PreOrderTreeIterator< TTreeType >::GetType ( ) const
overridevirtual

Get the type of the iterator

Return the type of the iterator

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 79 of file itkPreOrderTreeIterator.h.

References itk::PREORDER.

◆ HasNext()

template<typename TTreeType >
bool itk::PreOrderTreeIterator< TTreeType >::HasNext ( ) const
overrideprotectedvirtual

Return true if the next node exists

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 87 of file itkPreOrderTreeIterator.h.

◆ Next()

template<typename TTreeType >
const PreOrderTreeIterator< TTreeType >::ValueType & itk::PreOrderTreeIterator< TTreeType >::Next ( )
overrideprotectedvirtual

Return the next node

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 100 of file itkPreOrderTreeIterator.h.

Friends And Related Function Documentation

◆ LeafTreeIterator< TTreeType >

template<typename TTreeType>
friend class LeafTreeIterator< TTreeType >
friend

LeafTreeIterator uses PreOrderTreeIterator in its implementation, but it needs to adjust its root. A friend designation is added to correct behavior and retain backwards compatible behavior.

Definition at line 67 of file itkPreOrderTreeIterator.h.


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