itk::RootTreeIterator< TTreeType > Class Template Reference

#include <itkRootTreeIterator.h>

Inheritance diagram for itk::RootTreeIterator< TTreeType >:

[legend]Collaboration diagram for itk::RootTreeIterator< TTreeType >:

[legend]List of all members.

---

Detailed Description

template<class TTreeType>
class itk::RootTreeIterator< TTreeType >

Definition at line 25 of file itkRootTreeIterator.h.

Public Types
enum	{   UNDEFIND = 0,   PREORDER = 1,   INORDER = 2,   POSTORDER = 3,   LEVELORDER = 4,   CHILD = 5,   ROOT = 6,   LEAF = 7 }
typedef TreeIteratorBase	Self
typedef TreeIteratorBase< TTreeType >	Superclass
typedef Superclass::TreeNodeType	TreeNodeType
typedef TTreeType	TreeType
typedef TTreeType::ValueType	ValueType
Public Member Functions
virtual bool	Add (TTreeType &subTree)
virtual bool	Add (int position, ValueType element)
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 ValueType &	Get () const
virtual TreeIteratorBase< TTreeType > *	GetChild (int number) const
const TreeNodeType *	GetParent () const
virtual TTreeType *	GetSubTree () const
TTreeType *	GetTree () const
int	GetType () const
void	GoToBegin ()
virtual bool	GoToChild (int 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)
ValueType	Set (ValueType element)
TreeIteratorBase< TTreeType > *	Clone ()
virtual const TreeNodeType *	GetNode () const
virtual TreeNodeType *	GetNode ()
const TreeNodeType *	GetRoot () const
TreeNodeType *	GetRoot ()
Self &	operator++ ()
Protected Member Functions
bool	HasNext () const
const ValueType &	Next ()
Protected Attributes
TreeNodeType *	m_Begin
TreeNodeType *	m_End
TreeNodeType *	m_Position
const TreeNodeType *	m_Root
TTreeType *	m_Tree

---

Member Typedef Documentation

template<class TTreeType>

typedef TreeIteratorBase itk::TreeIteratorBase< TTreeType >::Self [inherited]

Typedefs

Reimplemented in itk::ChildTreeIterator< TTreeType >, itk::InOrderTreeIterator< TTreeType >, itk::LeafTreeIterator< TTreeType >, itk::LevelOrderTreeIterator< TTreeType >, and itk::PostOrderTreeIterator< TTreeType >.

Definition at line 35 of file itkTreeIteratorBase.h.

template<class TTreeType>

typedef TreeIteratorBase<TTreeType> itk::RootTreeIterator< TTreeType >::Superclass

Typedefs

Definition at line 30 of file itkRootTreeIterator.h.

template<class TTreeType>

typedef Superclass::TreeNodeType itk::RootTreeIterator< TTreeType >::TreeNodeType

Reimplemented from itk::TreeIteratorBase< TTreeType >.

Definition at line 33 of file itkRootTreeIterator.h.

template<class TTreeType>

typedef TTreeType itk::RootTreeIterator< TTreeType >::TreeType

Definition at line 31 of file itkRootTreeIterator.h.

template<class TTreeType>

typedef TTreeType::ValueType itk::RootTreeIterator< TTreeType >::ValueType

Reimplemented from itk::TreeIteratorBase< TTreeType >.

Definition at line 32 of file itkRootTreeIterator.h.

---

Member Enumeration Documentation

template<class TTreeType>

anonymous enum [inherited]

Enumerations

Enumerator:

UNDEFIND
PREORDER
INORDER
POSTORDER
LEVELORDER
CHILD
ROOT
LEAF

Definition at line 149 of file itkTreeIteratorBase.h.

---

Constructor & Destructor Documentation

template<class TTreeType>

itk::RootTreeIterator< TTreeType >::RootTreeIterator	(	TreeType *	tree,
		const TreeNodeType *	start = NULL
	)

Constructor

Definition at line 61 of file itkRootTreeIterator.h.

References itk::TreeIteratorBase< TTreeType >::m_Begin, itk::TreeIteratorBase< TTreeType >::m_Position, and itk::TreeIteratorBase< TTreeType >::m_Root.

template<class TTreeType>

itk::RootTreeIterator< TTreeType >::RootTreeIterator	(	TreeType *	tree,
		const TreeNodeType *	start = NULL
	)

Constructor

Definition at line 61 of file itkRootTreeIterator.h.

References itk::TreeIteratorBase< TTreeType >::m_Begin, itk::TreeIteratorBase< TTreeType >::m_Position, and itk::TreeIteratorBase< TTreeType >::m_Root.

---

Member Function Documentation

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::Add

(

TTreeType &

subTree

)

[virtual, inherited]

Add a subtree

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::Add	(	int	position,
		ValueType	element
	)			[virtual, inherited]

Add an element at a given position

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::Add

(

ValueType

element

)

[virtual, inherited]

Add an element to the tree

template<class TTreeType>

virtual int itk::TreeIteratorBase< TTreeType >::ChildPosition

(

ValueType

element

)

const [virtual, inherited]

Return the current ChildPosition of an element

template<class TTreeType>

virtual TreeIteratorBase<TTreeType>* itk::TreeIteratorBase< TTreeType >::Children

(

)

[virtual, inherited]

Return a list of children

template<class TTreeType>

TreeIteratorBase< TTreeType > * itk::RootTreeIterator< TTreeType >::Clone

(

)

[virtual]

Clone function

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 123 of file itkRootTreeIterator.h.

References itk::TreeIteratorBase< TTreeType >::m_Tree.

template<class TTreeType>

virtual int itk::TreeIteratorBase< TTreeType >::Count

(

)

[virtual, inherited]

Count the number of nodes

template<class TTreeType>

virtual int itk::TreeIteratorBase< TTreeType >::CountChildren

(

)

const [virtual, inherited]

Count the number of children

Referenced by itk::ChildTreeIterator< TTreeType >::HasNext().

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::Disconnect

(

)

[virtual, inherited]

Disconnect the tree

template<class TTreeType>

virtual const ValueType& itk::TreeIteratorBase< TTreeType >::Get

(

)

const [virtual, inherited]

Get a value

template<class TTreeType>

virtual TreeIteratorBase<TTreeType>* itk::TreeIteratorBase< TTreeType >::GetChild

(

int

number

)

const [virtual, inherited]

Return a list of child

template<class TTreeType>

virtual const TreeNodeType* itk::TreeIteratorBase< TTreeType >::GetNode

(

)

const [virtual, inherited]

template<class TTreeType>

virtual TreeNodeType* itk::TreeIteratorBase< TTreeType >::GetNode

(

)

[virtual, inherited]

Get the current node

template<class TTreeType>

const TreeNodeType* itk::TreeIteratorBase< TTreeType >::GetParent

(

)

const [inherited]

Return the first parent found

template<class TTreeType>

const TreeNodeType* itk::TreeIteratorBase< TTreeType >::GetRoot

(

)

const [inherited]

template<class TTreeType>

TreeNodeType* itk::TreeIteratorBase< TTreeType >::GetRoot

(

)

[inherited]

Get the root

template<class TTreeType>

virtual TTreeType* itk::TreeIteratorBase< TTreeType >::GetSubTree

(

)

const [virtual, inherited]

Get the subtree

template<class TTreeType>

TTreeType* itk::TreeIteratorBase< TTreeType >::GetTree

(

)

const [inherited]

Get the tree

template<class TTreeType>

int itk::RootTreeIterator< TTreeType >::GetType

(

)

const [virtual]

Return the type of the iterator

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 76 of file itkRootTreeIterator.h.

template<class TTreeType>

void itk::TreeIteratorBase< TTreeType >::GoToBegin

(

void

)

[inline, inherited]

Move an iterator to the beginning of the tree

Definition at line 122 of file itkTreeIteratorBase.h.

References itk::TreeIteratorBase< TTreeType >::m_Begin, and itk::TreeIteratorBase< TTreeType >::m_Position.

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::GoToChild

(

int

number = 0

)

[virtual, inherited]

Go to the specified child

Reimplemented in itk::ChildTreeIterator< TTreeType >.

template<class TTreeType>

void itk::TreeIteratorBase< TTreeType >::GoToEnd

(

void

)

[inline, inherited]

Move an iterator to the end of the tree.

Definition at line 128 of file itkTreeIteratorBase.h.

References itk::TreeIteratorBase< TTreeType >::m_End, and itk::TreeIteratorBase< TTreeType >::m_Position.

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::GoToParent

(

)

[virtual, inherited]

Go to the parent

Reimplemented in itk::ChildTreeIterator< TTreeType >.

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::HasChild

(

int

number = 0

)

const [virtual, inherited]

Return true if the current node has a child

template<class TTreeType>

bool itk::RootTreeIterator< TTreeType >::HasNext

(

)

const [protected, virtual]

Return true if the next node exists

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 84 of file itkRootTreeIterator.h.

References NULL.

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::HasParent

(

)

const [virtual, inherited]

Return true if the current node has a parent

template<class TTreeType>

bool itk::TreeIteratorBase< TTreeType >::IsAtBegin

(

void

)

const [inline, inherited]

Is the iterator at the beginning of the tree?

Definition at line 134 of file itkTreeIteratorBase.h.

References itk::TreeIteratorBase< TTreeType >::m_Begin, and itk::TreeIteratorBase< TTreeType >::m_Position.

template<class TTreeType>

bool itk::TreeIteratorBase< TTreeType >::IsAtEnd

(

void

)

const [inline, inherited]

Is the iterator at the end of the tree?. The iterator is at the end if it points to NULL

Definition at line 140 of file itkTreeIteratorBase.h.

References itk::TreeIteratorBase< TTreeType >::m_End, and itk::TreeIteratorBase< TTreeType >::m_Position.

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::IsLeaf

(

)

const [virtual, inherited]

Return true if the current node is a leaf

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::IsRoot

(

)

const [virtual, inherited]

Return true if the current node is a root

template<class TTreeType>

const RootTreeIterator< TTreeType >::ValueType & itk::RootTreeIterator< TTreeType >::Next

(

)

[protected, virtual]

Return the next node

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 97 of file itkRootTreeIterator.h.

References itk::TreeIteratorBase< TTreeType >::m_Position.

template<class TTreeType>

Self& itk::TreeIteratorBase< TTreeType >::operator++

(

)

[inline, inherited]

operator++

Definition at line 162 of file itkTreeIteratorBase.h.

References itk::TreeIteratorBase< TTreeType >::Next().

template<class TTreeType>

virtual TreeIteratorBase<TTreeType>* itk::TreeIteratorBase< TTreeType >::Parents

(

)

[virtual, inherited]

Return a list of parents

template<class TTreeType>

bool itk::TreeIteratorBase< TTreeType >::Remove

(

)

[inherited]

Remove the current node from the tree

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::RemoveChild

(

int

number

)

[virtual, inherited]

Remove a child

template<class TTreeType>

ValueType itk::TreeIteratorBase< TTreeType >::Set

(

ValueType

element

)

[inherited]

Set the current value of the node

---

Member Data Documentation

template<class TTreeType>

TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_Begin [mutable, protected, inherited]

Definition at line 189 of file itkTreeIteratorBase.h.

Referenced by itk::ChildTreeIterator< TTreeType >::ChildTreeIterator(), itk::TreeIteratorBase< TTreeType >::GoToBegin(), itk::ChildTreeIterator< TTreeType >::GoToChild(), itk::ChildTreeIterator< TTreeType >::GoToParent(), itk::TreeIteratorBase< TTreeType >::IsAtBegin(), itk::LeafTreeIterator< TTreeType >::LeafTreeIterator(), itk::TreeIteratorBase< TTreeType >::operator=(), itk::PostOrderTreeIterator< TTreeType >::PostOrderTreeIterator(), and itk::RootTreeIterator< TTreeType >::RootTreeIterator().

template<class TTreeType>

TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_End [mutable, protected, inherited]

Definition at line 190 of file itkTreeIteratorBase.h.

Referenced by itk::TreeIteratorBase< TTreeType >::GoToEnd(), itk::TreeIteratorBase< TTreeType >::IsAtEnd(), and itk::TreeIteratorBase< TTreeType >::operator=().

template<class TTreeType>

TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_Position [mutable, protected, inherited]

Definition at line 188 of file itkTreeIteratorBase.h.

Referenced by itk::ChildTreeIterator< TTreeType >::ChildTreeIterator(), itk::PreOrderTreeIterator< TTreeType >::Clone(), itk::PostOrderTreeIterator< TTreeType >::FindNextNode(), itk::LevelOrderTreeIterator< TTreeType >::GetLevel(), itk::TreeIteratorBase< TTreeType >::GoToBegin(), itk::ChildTreeIterator< TTreeType >::GoToChild(), itk::TreeIteratorBase< TTreeType >::GoToEnd(), itk::ChildTreeIterator< TTreeType >::GoToParent(), itk::TreeIteratorBase< TTreeType >::IsAtBegin(), itk::TreeIteratorBase< TTreeType >::IsAtEnd(), itk::RootTreeIterator< TTreeType >::Next(), itk::PreOrderTreeIterator< TTreeType >::Next(), itk::PostOrderTreeIterator< TTreeType >::Next(), itk::LevelOrderTreeIterator< TTreeType >::Next(), itk::LeafTreeIterator< TTreeType >::Next(), itk::InOrderTreeIterator< TTreeType >::Next(), itk::ChildTreeIterator< TTreeType >::Next(), itk::TreeIteratorBase< TTreeType >::operator=(), itk::PostOrderTreeIterator< TTreeType >::PostOrderTreeIterator(), and itk::RootTreeIterator< TTreeType >::RootTreeIterator().

template<class TTreeType>

const TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_Root [protected, inherited]

Definition at line 191 of file itkTreeIteratorBase.h.

Referenced by itk::LevelOrderTreeIterator< TTreeType >::GetLevel(), itk::TreeIteratorBase< TTreeType >::operator=(), and itk::RootTreeIterator< TTreeType >::RootTreeIterator().

template<class TTreeType>

TTreeType* itk::TreeIteratorBase< TTreeType >::m_Tree [protected, inherited]

Definition at line 192 of file itkTreeIteratorBase.h.

Referenced by itk::RootTreeIterator< TTreeType >::Clone(), itk::PreOrderTreeIterator< TTreeType >::Clone(), itk::PostOrderTreeIterator< TTreeType >::Clone(), itk::LevelOrderTreeIterator< TTreeType >::Clone(), itk::LeafTreeIterator< TTreeType >::Clone(), itk::ChildTreeIterator< TTreeType >::Clone(), and itk::TreeIteratorBase< TTreeType >::operator=().

---

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

• itkRootTreeIterator.h

---