itk::TreeContainer< TValueType > Class Template Reference
[Data Representation Objects]

TreeContainer class. More...

#include <itkTreeContainer.h>

Inheritance diagram for itk::TreeContainer< TValueType >:

[legend]Collaboration diagram for itk::TreeContainer< TValueType >:

[legend]List of all members.

Public Types
typedef TreeContainerBase< TValueType >	Superclass
typedef TreeContainer< TValueType >	Self
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TValueType	ValueType
typedef TreeNode< ValueType >	TreeNodeType
typedef TreeIteratorBase< Self >	IteratorType
typedef PreOrderTreeIterator< Self >	PreOrderIteratorType
Public Member Functions
virtual const char *	GetNameOfClass () const
	TreeContainer (int defaultChildrenCount)
	TreeContainer (TreeContainer< TValueType > &tree)
virtual bool	SetRoot (TValueType element)
bool	SetRoot (IteratorType &pos)
virtual bool	SetRoot (TreeNode< TValueType > *node)
bool	Contains (const TValueType element)
int	Count () const
bool	IsLeaf (const TValueType element)
bool	IsRoot (const TValueType element)
bool	Clear ()
bool	operator== (TreeContainer< TValueType > &tree)
bool	Swap (IteratorType &v, IteratorType &w)
const TreeNodeType *	GetRoot () const
bool	Add (const TValueType child, const TValueType parent)
const TreeNodeType *	GetNode (TValueType val) const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	TreeContainer ()
virtual	~TreeContainer ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
TreeNodeType::Pointer	m_Root
int	m_DefaultChildrenCount

---

Detailed Description

template<class TValueType>
class itk::TreeContainer< TValueType >

TreeContainer class.

This class derives from the TreeContainerBase class.

The class is templated over the type of the elements.

Template parameters for class TreeContainer:

• TValueType = Element type stored at each location in the Tree.

Definition at line 41 of file itkTreeContainer.h.

---

Member Typedef Documentation

template<class TValueType> typedef SmartPointer<const Self> itk::TreeContainer< TValueType >::ConstPointer

Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 50 of file itkTreeContainer.h.

template<class TValueType> typedef TreeIteratorBase<Self> itk::TreeContainer< TValueType >::IteratorType

Iterators typedef Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 55 of file itkTreeContainer.h.

template<class TValueType> typedef SmartPointer<Self> itk::TreeContainer< TValueType >::Pointer

Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 49 of file itkTreeContainer.h.

template<class TValueType> typedef PreOrderTreeIterator<Self> itk::TreeContainer< TValueType >::PreOrderIteratorType

Definition at line 56 of file itkTreeContainer.h.

template<class TValueType> typedef TreeContainer<TValueType> itk::TreeContainer< TValueType >::Self

Smart pointer typedef support. Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 48 of file itkTreeContainer.h.

template<class TValueType> typedef TreeContainerBase<TValueType> itk::TreeContainer< TValueType >::Superclass

Standard typedefs Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 47 of file itkTreeContainer.h.

template<class TValueType> typedef TreeNode<ValueType> itk::TreeContainer< TValueType >::TreeNodeType

Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 52 of file itkTreeContainer.h.

template<class TValueType> typedef TValueType itk::TreeContainer< TValueType >::ValueType

Reimplemented from itk::TreeContainerBase< TValueType >. Definition at line 51 of file itkTreeContainer.h.

---

Constructor & Destructor Documentation

template<class TValueType> itk::TreeContainer< TValueType >::TreeContainer (  int  defaultChildrenCount  )

Constructor

template<class TValueType> itk::TreeContainer< TValueType >::TreeContainer (  TreeContainer< TValueType > &  tree  )

Constructor

template<class TValueType> itk::TreeContainer< TValueType >::TreeContainer (   )  [protected]

template<class TValueType> virtual itk::TreeContainer< TValueType >::~TreeContainer (   )  [protected, virtual]

---

Member Function Documentation

template<class TValueType> bool itk::TreeContainer< TValueType >::Add (  const TValueType  child, const TValueType  parent )

Add a child to a given parent using values

template<class TValueType> bool itk::TreeContainer< TValueType >::Clear (   )  [virtual]

Clear the tree Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> bool itk::TreeContainer< TValueType >::Contains (  const TValueType  element  )  [virtual]

Return true if the element is in the tree Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> int itk::TreeContainer< TValueType >::Count (   )  const [virtual]

Return the number of elements in the tree Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> virtual const char* itk::TreeContainer< TValueType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

template<class TValueType> const TreeNodeType* itk::TreeContainer< TValueType >::GetNode (  TValueType  val  )  const

Get node given a value

template<class TValueType> const TreeNodeType* itk::TreeContainer< TValueType >::GetRoot (   )  const [inline, virtual]

Get the root Implements itk::TreeContainerBase< TValueType >. Definition at line 101 of file itkTreeContainer.h.

template<class TValueType> bool itk::TreeContainer< TValueType >::IsLeaf (  const TValueType  element  )  [virtual]

Return true if the element is a leaf Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> bool itk::TreeContainer< TValueType >::IsRoot (  const TValueType  element  )  [virtual]

Return true if the element is a root Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> Pointer itk::TreeContainer< TValueType >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

template<class TValueType> bool itk::TreeContainer< TValueType >::operator== (  TreeContainer< TValueType > &  tree  )

operator equal

template<class TValueType> void itk::TreeContainer< TValueType >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::Object.

template<class TValueType> virtual bool itk::TreeContainer< TValueType >::SetRoot (  TreeNode< TValueType > *  node  )  [virtual]

Set the root as a tree node Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> bool itk::TreeContainer< TValueType >::SetRoot (  IteratorType &  pos  )

The the root as an iterator position

template<class TValueType> virtual bool itk::TreeContainer< TValueType >::SetRoot (  TValueType  element  )  [virtual]

Set the root as an element Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> bool itk::TreeContainer< TValueType >::Swap (  IteratorType &  v, IteratorType &  w )

Swap the iterators

---

Member Data Documentation

template<class TValueType> int itk::TreeContainer< TValueType >::m_DefaultChildrenCount [protected]

Definition at line 115 of file itkTreeContainer.h.

template<class TValueType> TreeNodeType::Pointer itk::TreeContainer< TValueType >::m_Root [protected]

Definition at line 114 of file itkTreeContainer.h.

---

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

• itkTreeContainer.h

---