#include <itkTreeIteratorBase.h>

Inheritance diagram for itk::TreeIteratorBase< TTreeType >:

Public Types
enum	{ 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
virtual	~TreeIteratorBase ()

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 TreeIteratorBase < TTreeType > *	Clone ()=0

virtual int	Count ()

virtual int	CountChildren () const

virtual bool	Disconnect ()

virtual const ValueType &	Get () const

virtual TreeIteratorBase < TTreeType > *	GetChild (int number) const

virtual TreeNodeType *	GetNode ()

virtual const TreeNodeType *	GetNode () const

const TreeNodeType *	GetParent () const

TreeNodeType *	GetRoot ()

const TreeNodeType *	GetRoot () const

virtual TTreeType *	GetSubTree () const

TTreeType *	GetTree () const

virtual int	GetType () const =0

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

Self &	operator++ ()

void	operator++ (int)

const Self &	operator= (const Self &iterator)

virtual TreeIteratorBase < TTreeType > *	Parents ()

bool	Remove ()

virtual bool	RemoveChild (int number)

void	Set (ValueType element)

Protected Member Functions
	TreeIteratorBase (TTreeType tree, const TreeNodeType start)

	TreeIteratorBase (const TTreeType tree, const TreeNodeType start)

virtual bool	HasNext () const =0

virtual const ValueType &	Next ()=0

Protected Attributes
TreeNodeType *	m_Begin

TreeNodeType *	m_End

TreeNodeType *	m_Position

const TreeNodeType *	m_Root

TTreeType *	m_Tree

Detailed Description

template<class TTreeType>
class itk::TreeIteratorBase< TTreeType >

TreeIteratorBase class.

This class provides the base implementation for tree iterators

Events will notify interested observers about tree changes. These events all derive from TreeChangeEvent. They are:

TreeNodeChangeEvent: invoked when Set() is called, i.e. exactly one node changes
TreeAddEvent: invoked when Add() is called.
TreeRemoveEvent: when a single node has been removed, i.e. Disconnect() has been called.
TreePruneEvent: when a node and all its children were removed, i.e. Remove() has been called.

All those events have a member GetChangePosition(), which returns an iterator to the position that has changd. Please note that this iterator may not be fully functional, but you should always be able to use its Get() method to retrieve the thing it points to.

Definition at line 42 of file itkTreeIteratorBase.h.

Member Typedef Documentation

template<class TTreeType>

typedef TreeIteratorBase itk::TreeIteratorBase< TTreeType >::Self

Typedefs

Definition at line 47 of file itkTreeIteratorBase.h.

template<class TTreeType>

typedef TTreeType::TreeNodeType itk::TreeIteratorBase< TTreeType >::TreeNodeType

Definition at line 49 of file itkTreeIteratorBase.h.

template<class TTreeType>

typedef TTreeType::ValueType itk::TreeIteratorBase< TTreeType >::ValueType

Definition at line 48 of file itkTreeIteratorBase.h.

Member Enumeration Documentation

template<class TTreeType>

anonymous enum

Enumerations

Enumerator
UNDEFIND
PREORDER
INORDER
POSTORDER
LEVELORDER
CHILD
ROOT
LEAF

Definition at line 160 of file itkTreeIteratorBase.h.

Constructor & Destructor Documentation

template<class TTreeType>

virtual itk::TreeIteratorBase< TTreeType >::~TreeIteratorBase ( )

inlinevirtual

Definition at line 196 of file itkTreeIteratorBase.h.

template<class TTreeType >

itk::TreeIteratorBase< TTreeType >::TreeIteratorBase	(	TTreeType *	tree,
		const TreeNodeType *	start
	)

protected

Constructors

Constructor

Definition at line 28 of file itkTreeIteratorBase.txx.

References NULL.

template<class TTreeType >

itk::TreeIteratorBase< TTreeType >::TreeIteratorBase	(	const TTreeType *	tree,
		const TreeNodeType *	start
	)

protected

Constructor

Definition at line 47 of file itkTreeIteratorBase.txx.

References NULL.

Member Function Documentation

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::Add ( ValueType element )

virtual

Add an element to the tree

Add a value to the node. This creates a new child node

Definition at line 85 of file itkTreeIteratorBase.txx.

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

Referenced by itk::TreeContainer< TValueType >::Add(), and main().

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::Add	(	int	position,
		ValueType	element
	)

virtual

Add an element at a given position

Add a new element at a given position

Definition at line 123 of file itkTreeIteratorBase.txx.

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

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::Add ( TTreeType & subTree )

virtual

Add a subtree

Definition at line 171 of file itkTreeIteratorBase.txx.

References NULL.

template<class TTreeType >

int itk::TreeIteratorBase< TTreeType >::ChildPosition ( ValueType element ) const

virtual

Return the current ChildPosition of an element

Return the current position of the child

Definition at line 228 of file itkTreeIteratorBase.txx.

template<class TTreeType >

TreeIteratorBase< TTreeType > * itk::TreeIteratorBase< TTreeType >::Children ( )

virtual

Return a list of children

Return the children list

Definition at line 320 of file itkTreeIteratorBase.txx.

template<class TTreeType>

virtual TreeIteratorBase<TTreeType>* itk::TreeIteratorBase< TTreeType >::Clone ( )

pure virtual

Clone the iterator

Implemented in itk::LevelOrderTreeIterator< TTreeType >, itk::ChildTreeIterator< TTreeType >, itk::LeafTreeIterator< TTreeType >, itk::InOrderTreeIterator< TTreeType >, itk::PostOrderTreeIterator< TTreeType >, itk::RootTreeIterator< TTreeType >, and itk::PreOrderTreeIterator< TTreeType >.

template<class TTreeType >

int itk::TreeIteratorBase< TTreeType >::Count ( )

virtual

Count the number of nodes

Count the number of nodes from the beginning

Definition at line 410 of file itkTreeIteratorBase.txx.

template<class TTreeType >

int itk::TreeIteratorBase< TTreeType >::CountChildren ( ) const

virtual

Count the number of children

Definition at line 266 of file itkTreeIteratorBase.txx.

References NULL.

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::Disconnect ( )

virtual

Disconnect the tree

Definition at line 286 of file itkTreeIteratorBase.txx.

References NULL.

template<class TTreeType >

const TreeIteratorBase< TTreeType >::ValueType & itk::TreeIteratorBase< TTreeType >::Get ( void ) const

virtual

Get a value

Return the current value of the node

Definition at line 66 of file itkTreeIteratorBase.txx.

Referenced by itk::TreeContainer< TValueType >::Add(), itk::TreeContainer< TValueType >::Contains(), otb::VectorDataEditionModel::DeleteSelectedGeometriesInROI(), otb::DBOverlapDataNodeFeatureFunction< TCoordRep, TPrecision >::Evaluate(), otb::ListSampleGenerator< TImage, TVectorData >::GenerateClassStatistics(), otb::VectorDataToRightAngleVectorDataFilter< TVectorData >::GenerateData(), otb::VectorDataToRoadDescriptionFilter< TVectorData, TOpticalImage >::GenerateData(), otb::ListSampleGenerator< TImage, TVectorData >::GenerateData(), otb::VectorDataToDSValidatedVectorDataFilter< TVectorData, TPrecision >::GenerateData(), itk::TreeContainer< TValueType >::GetNode(), itk::TreeContainer< TValueType >::IsLeaf(), itk::TreeContainer< TValueType >::IsRoot(), main(), itk::TreeContainer< TValueType >::operator==(), itk::TreeContainer< TValueType >::PrintSelf(), otb::VectorData< TPrecision, VDimension, TValuePrecision >::PrintSelf(), otb::VectorDataEditionModel::SearchDataNodeIndexFromPoint(), and otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >::ThreadedGenerateData().

template<class TTreeType >

TreeIteratorBase< TTreeType > * itk::TreeIteratorBase< TTreeType >::GetChild ( int number ) const

virtual

Return a list of child

Get a child given a number

Definition at line 391 of file itkTreeIteratorBase.txx.

References NULL.

template<class TTreeType >

TreeIteratorBase< TTreeType >::TreeNodeType * itk::TreeIteratorBase< TTreeType >::GetNode ( )

virtual

Get the current node

Get the node pointed by the iterator

Definition at line 428 of file itkTreeIteratorBase.txx.

Referenced by itk::LeafTreeIterator< TTreeType >::FindNextNode(), itk::TreeContainer< TValueType >::GetNode(), itk::TreeContainer< TValueType >::SetRoot(), and itk::TreeContainer< TValueType >::Swap().

template<class TTreeType >

const TreeIteratorBase< TTreeType >::TreeNodeType * itk::TreeIteratorBase< TTreeType >::GetNode ( ) const

virtual

Get the node pointed by the iterator

Definition at line 436 of file itkTreeIteratorBase.txx.

template<class TTreeType >

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

Return the first parent found

Definition at line 332 of file itkTreeIteratorBase.txx.

References NULL.

Referenced by itk::TreeContainer< TValueType >::PrintSelf().

template<class TTreeType >

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

Get the root

Definition at line 444 of file itkTreeIteratorBase.txx.

template<class TTreeType >

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

Get the root (const)

Definition at line 452 of file itkTreeIteratorBase.txx.

template<class TTreeType >

TTreeType * itk::TreeIteratorBase< TTreeType >::GetSubTree ( ) const

virtual

Get the subtree

Return the subtree

Definition at line 201 of file itkTreeIteratorBase.txx.

template<class TTreeType >

TTreeType * itk::TreeIteratorBase< TTreeType >::GetTree ( ) const

Get the tree

Return the tree

Definition at line 501 of file itkTreeIteratorBase.txx.

template<class TTreeType>

virtual int itk::TreeIteratorBase< TTreeType >::GetType ( ) const

pure virtual

Get the type of iterator

Implemented in itk::LeafTreeIterator< TTreeType >, itk::ChildTreeIterator< TTreeType >, itk::LevelOrderTreeIterator< TTreeType >, itk::InOrderTreeIterator< TTreeType >, itk::PostOrderTreeIterator< TTreeType >, itk::RootTreeIterator< TTreeType >, and itk::PreOrderTreeIterator< TTreeType >.

template<class TTreeType>

void itk::TreeIteratorBase< TTreeType >::GoToBegin ( void )

inline

Move an iterator to the beginning of the tree

Definition at line 132 of file itkTreeIteratorBase.h.

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

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::GoToChild ( int number = 0 )

virtual

Go to the specified child

Go to a child

Reimplemented in itk::ChildTreeIterator< TTreeType >.

Definition at line 354 of file itkTreeIteratorBase.txx.

References NULL.

Referenced by main().

template<class TTreeType>

void itk::TreeIteratorBase< TTreeType >::GoToEnd ( void )

inline

Move an iterator to the end of the tree.

Definition at line 138 of file itkTreeIteratorBase.h.

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

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::GoToParent ( )

virtual

Go to the parent

Go to a parent

Reimplemented in itk::ChildTreeIterator< TTreeType >.

Definition at line 373 of file itkTreeIteratorBase.txx.

References NULL.

Referenced by otb::VectorData< TPrecision, VDimension, TValuePrecision >::PrintSelf().

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::HasChild ( int number = 0 ) const

virtual

Return true if the current node has a child

Return true of the current node has a child

Definition at line 212 of file itkTreeIteratorBase.txx.

References NULL.

Referenced by itk::LeafTreeIterator< TTreeType >::FindNextNode().

template<class TTreeType>

virtual bool itk::TreeIteratorBase< TTreeType >::HasNext ( ) const

protectedpure virtual

Implemented in itk::LevelOrderTreeIterator< TTreeType >, itk::ChildTreeIterator< TTreeType >, itk::LeafTreeIterator< TTreeType >, itk::InOrderTreeIterator< TTreeType >, itk::RootTreeIterator< TTreeType >, itk::PostOrderTreeIterator< TTreeType >, and itk::PreOrderTreeIterator< TTreeType >.

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::HasParent ( ) const

virtual

Return true if the current node has a parent

Return true of the pointed node has a parent

Definition at line 278 of file itkTreeIteratorBase.txx.

References NULL.

Referenced by itk::TreeContainer< TValueType >::IsRoot(), and otb::VectorData< TPrecision, VDimension, TValuePrecision >::PrintSelf().

template<class TTreeType>

bool itk::TreeIteratorBase< TTreeType >::IsAtBegin ( void ) const

inline

Is the iterator at the beginning of the tree?

Definition at line 144 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

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

Definition at line 151 of file itkTreeIteratorBase.h.

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

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::IsLeaf ( ) const

virtual

Return true if the current node is a leaf

Return true if the current pointed node is a leaf

Definition at line 146 of file itkTreeIteratorBase.txx.

Referenced by itk::TreeContainer< TValueType >::IsLeaf().

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::IsRoot ( ) const

virtual

Return true if the current node is a root

Return true if the current pointed node is a root

Definition at line 154 of file itkTreeIteratorBase.txx.

References NULL.

template<class TTreeType>

virtual const ValueType& itk::TreeIteratorBase< TTreeType >::Next ( )

protectedpure virtual

Implemented in itk::LevelOrderTreeIterator< TTreeType >, itk::ChildTreeIterator< TTreeType >, itk::LeafTreeIterator< TTreeType >, itk::InOrderTreeIterator< TTreeType >, itk::RootTreeIterator< TTreeType >, itk::PostOrderTreeIterator< TTreeType >, and itk::PreOrderTreeIterator< TTreeType >.

Referenced by itk::TreeIteratorBase< TTreeType >::operator++().

template<class TTreeType>

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

inline

operator++

Definition at line 173 of file itkTreeIteratorBase.h.

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

template<class TTreeType>

void itk::TreeIteratorBase< TTreeType >::operator++ ( int )

inline

operator++

Definition at line 180 of file itkTreeIteratorBase.h.

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

template<class TTreeType>

const Self& itk::TreeIteratorBase< TTreeType >::operator= ( const Self & iterator )

inline

operator =

Definition at line 186 of file itkTreeIteratorBase.h.

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

Referenced by itk::ChildTreeIterator< TTreeType >::operator=(), and itk::LevelOrderTreeIterator< TTreeType >::operator=().

template<class TTreeType >

TreeIteratorBase< TTreeType > * itk::TreeIteratorBase< TTreeType >::Parents ( )

virtual

Return a list of parents

Return the list of parents

Definition at line 344 of file itkTreeIteratorBase.txx.

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::Remove ( )

Remove the current node from the tree

Remove a specific node (and its child nodes!)

Definition at line 460 of file itkTreeIteratorBase.txx.

References NULL.

Referenced by itk::TreeContainer< TValueType >::Clear(), and otb::VectorDataEditionModel::DeleteSelectedGeometriesInROI().

template<class TTreeType >

bool itk::TreeIteratorBase< TTreeType >::RemoveChild ( int number )

virtual

Remove a child

Definition at line 240 of file itkTreeIteratorBase.txx.

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

template<class TTreeType >

void itk::TreeIteratorBase< TTreeType >::Set ( ValueType element )

Set the current value of the node

Definition at line 74 of file itkTreeIteratorBase.txx.

Member Data Documentation

template<class TTreeType>

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

mutableprotected

Definition at line 205 of file itkTreeIteratorBase.h.

Referenced by itk::ChildTreeIterator< TTreeType >::ChildTreeIterator(), itk::TreeIteratorBase< TTreeType >::GoToBegin(), 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

mutableprotected

Definition at line 206 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

mutableprotected

Definition at line 204 of file itkTreeIteratorBase.h.

Referenced by itk::TreeIteratorBase< TTreeType >::Add(), itk::ChildTreeIterator< TTreeType >::ChildTreeIterator(), itk::TreeIteratorBase< TTreeType >::GoToBegin(), itk::TreeIteratorBase< TTreeType >::GoToEnd(), itk::TreeIteratorBase< TTreeType >::IsAtBegin(), itk::TreeIteratorBase< TTreeType >::IsAtEnd(), itk::TreeIteratorBase< TTreeType >::operator=(), itk::PostOrderTreeIterator< TTreeType >::PostOrderTreeIterator(), itk::TreeIteratorBase< TTreeType >::RemoveChild(), and itk::RootTreeIterator< TTreeType >::RootTreeIterator().

template<class TTreeType>

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

protected

Definition at line 207 of file itkTreeIteratorBase.h.

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

template<class TTreeType>

TTreeType* itk::TreeIteratorBase< TTreeType >::m_Tree

protected

Definition at line 208 of file itkTreeIteratorBase.h.

Referenced by itk::TreeIteratorBase< TTreeType >::operator=().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class TTreeType> class itk::TreeIteratorBase< TTreeType >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TTreeType>
class itk::TreeIteratorBase< TTreeType >