ITK  4.9.0
Insight Segmentation and Registration 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 >:

Detailed Description

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

Examples:
Examples/DataRepresentation/Containers/TreeContainer.cxx, and Examples/SpatialObjects/SpatialObjectTreeContainer.cxx.

Definition at line 30 of file itkPreOrderTreeIterator.h.

Public Types

typedef Superclass::NodeType NodeType
 
typedef TreeIteratorBase
< TTreeType > 
Superclass
 
typedef Superclass::TreeNodeType TreeNodeType
 
typedef TTreeType::ValueType ValueType
 
- Public Types inherited from itk::TreeIteratorBase< TTreeType >
typedef
TreeNodeType::ChildIdentifier 
ChildIdentifier
 
enum  NodeType {
  UNDEFIND = 0,
  PREORDER = 1,
  INORDER = 2,
  POSTORDER = 3,
  LEVELORDER = 4,
  CHILD = 5,
  ROOT = 6,
  LEAF = 7
}
 
typedef TreeIteratorBase Self
 
typedef TTreeType::TreeNodeType TreeNodeType
 
typedef TTreeType::ValueType ValueType
 

Public Member Functions

NodeType GetType () const
 
 PreOrderTreeIterator (const TTreeType *tree, const TreeNodeType *start=nullptr)
 
- Public Member Functions inherited from itk::TreeIteratorBase< TTreeType >
virtual bool Add (ValueType element)
 
virtual bool Add (int position, ValueType element)
 
virtual bool Add (TTreeType &subTree)
 
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 (void) const
 
bool IsAtEnd (void) const
 
virtual bool IsLeaf () const
 
virtual bool IsRoot () const
 
virtual TreeIteratorBase
< TTreeType > * 
Parents ()
 
bool Remove ()
 
virtual bool RemoveChild (int number)
 
void Set (ValueType element)
 
virtual ~TreeIteratorBase ()
 
Selfoperator++ ()
 
void operator++ (int)
 
Selfoperator= (const Self &iterator)
 

Protected Member Functions

const ValueTypeNext ()
 
bool HasNext () const
 
- Protected Member Functions inherited from itk::TreeIteratorBase< TTreeType >
 TreeIteratorBase (TTreeType *tree, const TreeNodeType *start)
 
 TreeIteratorBase (const TTreeType *tree, const TreeNodeType *start)
 

Friends

class LeafTreeIterator< TTreeType >
 
TreeIteratorBase< TTreeType > * Clone ()
 
const TreeNodeTypeFindNextNode () const
 

Additional Inherited Members

- Protected Attributes inherited from itk::TreeIteratorBase< TTreeType >
TreeNodeTypem_Begin
 
TreeNodeTypem_End
 
TreeNodeTypem_Position
 
const TreeNodeTypem_Root
 
TTreeType * m_Tree
 

Member Typedef Documentation

template<typename TTreeType>
typedef Superclass::NodeType itk::PreOrderTreeIterator< TTreeType >::NodeType

Definition at line 38 of file itkPreOrderTreeIterator.h.

template<typename TTreeType>
typedef TreeIteratorBase< TTreeType > itk::PreOrderTreeIterator< TTreeType >::Superclass

Definition at line 36 of file itkPreOrderTreeIterator.h.

template<typename TTreeType>
typedef Superclass::TreeNodeType itk::PreOrderTreeIterator< TTreeType >::TreeNodeType

Definition at line 37 of file itkPreOrderTreeIterator.h.

template<typename TTreeType>
typedef TTreeType::ValueType itk::PreOrderTreeIterator< TTreeType >::ValueType

Typedefs

Definition at line 35 of file itkPreOrderTreeIterator.h.

Constructor & Destructor Documentation

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

Constructor

Definition at line 69 of file itkPreOrderTreeIterator.h.

Member Function Documentation

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

Clone function

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 176 of file itkPreOrderTreeIterator.h.

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

Find the next node

Definition at line 107 of file itkPreOrderTreeIterator.h.

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

Get the type of the iterator

Return the type of the iterator

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 76 of file itkPreOrderTreeIterator.h.

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

Return true if the next node exists

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 84 of file itkPreOrderTreeIterator.h.

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

Return the next node

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 97 of file itkPreOrderTreeIterator.h.

Friends And Related Function Documentation

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


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