#include <itkTreeContainer.h>

Inheritance diagram for itk::TreeContainer< TValue >:

Collaboration diagram for itk::TreeContainer< TValue >:

Detailed Description

template<typename TValue>
class itk::TreeContainer< TValue >

A tree container.

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

Template Parameters

TValue Element type stored at each location in the Tree.

Examples:: Examples/DataRepresentation/Containers/TreeContainer.cxx.

Definition at line 38 of file itkTreeContainer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef TreeIteratorBase< Self >	IteratorType

typedef SmartPointer< Self >	Pointer

typedef PreOrderTreeIterator < Self >	PreOrderIteratorType

typedef TreeContainer< TValue >	Self

typedef TreeContainerBase< TValue >	Superclass

typedef TreeNode< ValueType >	TreeNodeType

typedef TValue	ValueType

Public Types inherited from itk::TreeContainerBase< TValue >
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef TreeContainerBase	Self

typedef Object	Superclass

typedef TValue	ValueType

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
bool	Add (const TValue child, const TValue parent)

bool	Clear () override

bool	Contains (const TValue element) override

int	Count () const override

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

const TreeNodeType *	GetNode (TValue val) const

const TreeNodeType *	GetRoot () const override

bool	IsLeaf (const TValue element) override

bool	IsRoot (const TValue element) override

bool	operator== (TreeContainer< TValue > &tree)

virtual bool	SetRoot (const TValue element) override

bool	SetRoot (IteratorType &pos)

virtual bool	SetRoot (TreeNode< TValue > *node) override

bool	Swap (IteratorType &v, IteratorType &w)

	TreeContainer (int defaultChildrenCount)

	TreeContainer (TreeContainer< TValue > &tree)

Public Member Functions inherited from itk::TreeContainerBase< TValue >
void	SetSubtree (bool val)

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override

	TreeContainer ()

virtual	~TreeContainer ()

Protected Member Functions inherited from itk::TreeContainerBase< TValue >
	TreeContainerBase ()

virtual	~TreeContainerBase ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
int	m_DefaultChildrenCount

TreeNodeType::Pointer	m_Root

Protected Attributes inherited from itk::TreeContainerBase< TValue >
bool	m_SubTree

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TValue>

typedef SmartPointer< const Self > itk::TreeContainer< TValue >::ConstPointer

Definition at line 46 of file itkTreeContainer.h.

template<typename TValue>

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

Iterators typedef

Definition at line 51 of file itkTreeContainer.h.

template<typename TValue>

typedef SmartPointer< Self > itk::TreeContainer< TValue >::Pointer

Definition at line 45 of file itkTreeContainer.h.

template<typename TValue>

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

Definition at line 52 of file itkTreeContainer.h.

template<typename TValue>

typedef TreeContainer< TValue > itk::TreeContainer< TValue >::Self

Definition at line 44 of file itkTreeContainer.h.

template<typename TValue>

typedef TreeContainerBase< TValue > itk::TreeContainer< TValue >::Superclass

Standard typedefs

Definition at line 43 of file itkTreeContainer.h.

template<typename TValue>

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

Definition at line 48 of file itkTreeContainer.h.

template<typename TValue>

typedef TValue itk::TreeContainer< TValue >::ValueType

Definition at line 47 of file itkTreeContainer.h.

Constructor & Destructor Documentation

template<typename TValue>

itk::TreeContainer< TValue >::TreeContainer ( int defaultChildrenCount )

Constructor

template<typename TValue>

itk::TreeContainer< TValue >::TreeContainer ( TreeContainer< TValue > & tree )

Constructor

template<typename TValue>

itk::TreeContainer< TValue >::TreeContainer ( )

protected

template<typename TValue>

virtual itk::TreeContainer< TValue >::~TreeContainer ( )

protectedvirtual

Member Function Documentation

template<typename TValue>

bool itk::TreeContainer< TValue >::Add	(	const TValue	child,
		const TValue	parent
	)

Add a child to a given parent using values

template<typename TValue>

bool itk::TreeContainer< TValue >::Clear ( )

overridevirtual

Clear the tree

Implements itk::TreeContainerBase< TValue >.

template<typename TValue>

bool itk::TreeContainer< TValue >::Contains ( const TValue element )

overridevirtual

Return true if the element is in the tree

Implements itk::TreeContainerBase< TValue >.

template<typename TValue>

int itk::TreeContainer< TValue >::Count ( ) const

overridevirtual

Return the number of elements in the tree

Implements itk::TreeContainerBase< TValue >.

template<typename TValue>

virtual::itk::LightObject::Pointer itk::TreeContainer< TValue >::CreateAnother ( ) 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.

template<typename TValue>

virtual const char* itk::TreeContainer< TValue >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::TreeContainerBase< TValue >.

Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

template<typename TValue>

const TreeNodeType* itk::TreeContainer< TValue >::GetNode ( TValue val ) const

Get node given a value

template<typename TValue>

const TreeNodeType* itk::TreeContainer< TValue >::GetRoot ( ) const

inlineoverridevirtual

Get the root

Implements itk::TreeContainerBase< TValue >.

Definition at line 97 of file itkTreeContainer.h.

template<typename TValue>

bool itk::TreeContainer< TValue >::IsLeaf ( const TValue element )

overridevirtual

Return true if the element is a leaf

Implements itk::TreeContainerBase< TValue >.

template<typename TValue>

bool itk::TreeContainer< TValue >::IsRoot ( const TValue element )

overridevirtual

Return true if the element is a root

Implements itk::TreeContainerBase< TValue >.

template<typename TValue>

static Pointer itk::TreeContainer< TValue >::New ( )

static

Method for creation through the object factory.

template<typename TValue>

bool itk::TreeContainer< TValue >::operator== ( TreeContainer< TValue > & tree )

operator equal

template<typename TValue>

void itk::TreeContainer< TValue >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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<typename TValue>

virtual bool itk::TreeContainer< TValue >::SetRoot ( const TValue element )

overridevirtual

Set the root as an element

Implements itk::TreeContainerBase< TValue >.

Referenced by itk::SpatialObjectTreeContainer< TDimension >::SetRoot().

template<typename TValue>

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

The the root as an iterator position

template<typename TValue>

virtual bool itk::TreeContainer< TValue >::SetRoot ( TreeNode< TValue > * node )