A tree container. More...

#include <itkTreeContainer.h>

Inheritance diagram for itk::TreeContainer< TValueType >:

Collaboration diagram for itk::TreeContainer< TValueType >:

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

Detailed Description

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

A tree container.

This class derives from the TreeContainerBase class. The class is templated over the type of the elements.

Template Parameters:

TValueType Element type stored at each location in the Tree.

Definition at line 38 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 46 of file itkTreeContainer.h.

template<class TValueType>

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

Iterators typedef

Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

Definition at line 51 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 45 of file itkTreeContainer.h.

template<class TValueType>

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

Definition at line 52 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 44 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 43 of file itkTreeContainer.h.

template<class TValueType>

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

Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

Definition at line 48 of file itkTreeContainer.h.

template<class TValueType>

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

Reimplemented from itk::TreeContainerBase< TValueType >.

Definition at line 47 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::itk::LightObject::Pointer itk::TreeContainer< TValueType >::CreateAnother ( void ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

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 97 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>

static 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>

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

The the root as an iterator position

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>

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

Set the root as an element

Implements itk::TreeContainerBase< TValueType >.