Orfeo Toolbox  4.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::RootTreeIterator< TTreeType > Class Template Reference

#include <itkRootTreeIterator.h>

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

Public Types

typedef
TreeNodeType::ChildIdentifier 
ChildIdentifier
 
typedef Superclass::NodeType NodeType
 
typedef TreeIteratorBase Self
 
typedef TreeIteratorBase
< TTreeType > 
Superclass
 
typedef Superclass::TreeNodeType TreeNodeType
 
typedef TTreeType TreeType
 
typedef TTreeType::ValueType ValueType
 

Public Member Functions

 RootTreeIterator (TreeType *tree, const TreeNodeType *start=NULL)
 
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 ()
 
TreeIteratorBase< TTreeType > * Clone ()
 
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
 
NodeType GetType () 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
 
Selfoperator++ ()
 
void operator++ (int)
 
virtual TreeIteratorBase
< TTreeType > * 
Parents ()
 
bool Remove ()
 
virtual bool RemoveChild (int number)
 
void Set (ValueType element)
 

Protected Member Functions

bool HasNext () const
 
const ValueTypeNext ()
 

Protected Attributes

TreeNodeTypem_Begin
 
TreeNodeTypem_End
 
TreeNodeTypem_Position
 
const TreeNodeTypem_Root
 
TTreeType * m_Tree
 

Private Member Functions

const TreeNodeTypeFindNextNode () const
 

Detailed Description

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

Definition at line 26 of file itkRootTreeIterator.h.

Member Typedef Documentation

template<typename TTreeType>
typedef TreeNodeType::ChildIdentifier itk::TreeIteratorBase< TTreeType >::ChildIdentifier
inherited

Definition at line 50 of file itkTreeIteratorBase.h.

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

Definition at line 35 of file itkRootTreeIterator.h.

template<typename TTreeType>
typedef TreeIteratorBase itk::TreeIteratorBase< TTreeType >::Self
inherited

Typedefs

Definition at line 47 of file itkTreeIteratorBase.h.

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

Typedefs

Definition at line 31 of file itkRootTreeIterator.h.

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

Definition at line 34 of file itkRootTreeIterator.h.

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

Definition at line 32 of file itkRootTreeIterator.h.

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

Definition at line 33 of file itkRootTreeIterator.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Add an element to the tree

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

Definition at line 99 of file itkTreeIteratorBase.hxx.

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

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

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

Add an element at a given position

Add a new element at a given position

Definition at line 138 of file itkTreeIteratorBase.hxx.

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

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

Add a subtree

Definition at line 187 of file itkTreeIteratorBase.hxx.

References NULL.

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

Return the current ChildPosition of an element

Return the current position of the child

Definition at line 244 of file itkTreeIteratorBase.hxx.

template<typename TTreeType >
TreeIteratorBase< TTreeType > * itk::TreeIteratorBase< TTreeType >::Children ( )
virtualinherited

Return a list of children

Return the children list

Definition at line 341 of file itkTreeIteratorBase.hxx.

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

Clone function

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 120 of file itkRootTreeIterator.h.

template<typename TTreeType >
int itk::TreeIteratorBase< TTreeType >::Count ( )
virtualinherited

Count the number of nodes

Count the number of nodes from the beginning

Definition at line 431 of file itkTreeIteratorBase.hxx.

template<typename TTreeType >
int itk::TreeIteratorBase< TTreeType >::CountChildren ( ) const
virtualinherited

Count the number of children

Definition at line 284 of file itkTreeIteratorBase.hxx.

References NULL.

template<typename TTreeType >
bool itk::TreeIteratorBase< TTreeType >::Disconnect ( )
virtualinherited

Disconnect the tree

Definition at line 304 of file itkTreeIteratorBase.hxx.

References NULL.

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

Find the next node

Definition at line 105 of file itkRootTreeIterator.h.

References NULL.

template<typename TTreeType >
const TreeIteratorBase< TTreeType >::ValueType & itk::TreeIteratorBase< TTreeType >::Get ( void  ) const
virtualinherited
template<typename TTreeType >
TreeIteratorBase< TTreeType > * itk::TreeIteratorBase< TTreeType >::GetChild ( int  number) const
virtualinherited

Return a list of child

Get a child given a number

Definition at line 411 of file itkTreeIteratorBase.hxx.

References NULL.

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

Get the node pointed by the iterator

Definition at line 458 of file itkTreeIteratorBase.hxx.

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

Return the first parent found

Definition at line 352 of file itkTreeIteratorBase.hxx.

References NULL.

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

template<typename TTreeType >
TreeIteratorBase< TTreeType >::TreeNodeType * itk::TreeIteratorBase< TTreeType >::GetRoot ( )
inherited

Get the root

Definition at line 466 of file itkTreeIteratorBase.hxx.

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

Get the root (const)

Definition at line 474 of file itkTreeIteratorBase.hxx.

template<typename TTreeType >
TTreeType * itk::TreeIteratorBase< TTreeType >::GetSubTree ( ) const
virtualinherited

Get the subtree

Return the subtree

Definition at line 217 of file itkTreeIteratorBase.hxx.

template<typename TTreeType >
TTreeType * itk::TreeIteratorBase< TTreeType >::GetTree ( ) const
inherited

Get the tree

Return the tree

Definition at line 526 of file itkTreeIteratorBase.hxx.

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

Return the type of the iterator

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 76 of file itkRootTreeIterator.h.

template<typename TTreeType>
void itk::TreeIteratorBase< TTreeType >::GoToBegin ( void  )
inlineinherited
template<typename TTreeType >
bool itk::TreeIteratorBase< TTreeType >::GoToChild ( ChildIdentifier  number = 0)
virtualinherited

Go to the specified child

Go to a child

Reimplemented in itk::ChildTreeIterator< TTreeType >.

Definition at line 374 of file itkTreeIteratorBase.hxx.

References NULL.

template<typename TTreeType>
void itk::TreeIteratorBase< TTreeType >::GoToEnd ( void  )
inlineinherited

Move an iterator to the end of the tree.

Definition at line 152 of file itkTreeIteratorBase.h.

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

template<typename TTreeType >
bool itk::TreeIteratorBase< TTreeType >::GoToParent ( )
virtualinherited

Go to the parent

Go to a parent

Reimplemented in itk::ChildTreeIterator< TTreeType >.

Definition at line 393 of file itkTreeIteratorBase.hxx.

References NULL.

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

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

Return true if the current node has a child

Return true of the current node has a child

Definition at line 228 of file itkTreeIteratorBase.hxx.

References NULL.

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

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

Return true if the next node exists

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 84 of file itkRootTreeIterator.h.

References NULL.

template<typename TTreeType >
bool itk::TreeIteratorBase< TTreeType >::HasParent ( ) const
virtualinherited

Return true if the current node has a parent

Return true of the pointed node has a parent

Definition at line 296 of file itkTreeIteratorBase.hxx.

References NULL.

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

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

Is the iterator at the beginning of the tree?

Definition at line 155 of file itkTreeIteratorBase.h.

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

template<typename TTreeType>
bool itk::TreeIteratorBase< TTreeType >::IsAtEnd ( void  ) const
inlineinherited
template<typename TTreeType >
bool itk::TreeIteratorBase< TTreeType >::IsLeaf ( ) const
virtualinherited

Return true if the current node is a leaf

Return true if the current pointed node is a leaf

Definition at line 162 of file itkTreeIteratorBase.hxx.

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

template<typename TTreeType >
bool itk::TreeIteratorBase< TTreeType >::IsRoot ( ) const
virtualinherited

Return true if the current node is a root

Return true if the current pointed node is a root

Definition at line 170 of file itkTreeIteratorBase.hxx.

References NULL.

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

Return the next node

Go to the next node

Implements itk::TreeIteratorBase< TTreeType >.

Definition at line 96 of file itkRootTreeIterator.h.

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

operator++

Definition at line 166 of file itkTreeIteratorBase.h.

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

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

operator++

Definition at line 174 of file itkTreeIteratorBase.h.

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

template<typename TTreeType >
TreeIteratorBase< TTreeType > * itk::TreeIteratorBase< TTreeType >::Parents ( )
virtualinherited

Return a list of parents

Return the list of parents

Definition at line 364 of file itkTreeIteratorBase.hxx.

template<typename TTreeType >
bool itk::TreeIteratorBase< TTreeType >::Remove ( )
inherited

Remove the current node from the tree

Remove a specific node (and its child nodes!)

Definition at line 482 of file itkTreeIteratorBase.hxx.

References NULL.

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

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

Remove a child

Definition at line 256 of file itkTreeIteratorBase.hxx.

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

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

Set the current value of the node

Definition at line 88 of file itkTreeIteratorBase.hxx.

Member Data Documentation

template<typename TTreeType>
TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_Begin
mutableprotectedinherited
template<typename TTreeType>
TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_End
mutableprotectedinherited
template<typename TTreeType>
TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_Position
mutableprotectedinherited
template<typename TTreeType>
const TreeNodeType* itk::TreeIteratorBase< TTreeType >::m_Root
protectedinherited
template<typename TTreeType>
TTreeType* itk::TreeIteratorBase< TTreeType >::m_Tree
protectedinherited

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

Generated at Sat Mar 8 2014 17:39:58 for Orfeo Toolbox with doxygen 1.8.3.1