#include <itkTreeContainer.h>

Inheritance diagram for itk::TreeContainer< TValue >:

Collaboration diagram for itk::TreeContainer< TValue >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IteratorType = TreeIteratorBase< Self >

using	Pointer = SmartPointer< Self >

using	PreOrderIteratorType = PreOrderTreeIterator< Self >

using	Self = TreeContainer< TValue >

using	Superclass = TreeContainerBase< TValue >

using	TreeNodeType = TreeNode< ValueType >

using	ValueType = TValue

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

using	Pointer = SmartPointer< Self >

using	Self = TreeContainerBase

using	Superclass = Object

using	ValueType = TValue

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

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)

bool	SetRoot (const TValue element) override

bool	SetRoot (IteratorType &pos)

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

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 ()

	~TreeContainer () override=default

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

	~TreeContainerBase () override=default

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &time)

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 { false }

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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.

Member Typedef Documentation

◆ ConstPointer

template<typename TValue>

using itk::TreeContainer< TValue >::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkTreeContainer.h.

◆ IteratorType

template<typename TValue>

using itk::TreeContainer< TValue >::IteratorType = TreeIteratorBase<Self>

Iterators type alias

Definition at line 50 of file itkTreeContainer.h.

◆ Pointer

template<typename TValue>

using itk::TreeContainer< TValue >::Pointer = SmartPointer<Self>

Definition at line 44 of file itkTreeContainer.h.

◆ PreOrderIteratorType

template<typename TValue>

using itk::TreeContainer< TValue >::PreOrderIteratorType = PreOrderTreeIterator<Self>

Definition at line 51 of file itkTreeContainer.h.

◆ Self

template<typename TValue>

using itk::TreeContainer< TValue >::Self = TreeContainer<TValue>

Definition at line 43 of file itkTreeContainer.h.

◆ Superclass

template<typename TValue>

using itk::TreeContainer< TValue >::Superclass = TreeContainerBase<TValue>

Standard type alias

Definition at line 42 of file itkTreeContainer.h.

◆ TreeNodeType

template<typename TValue>

using itk::TreeContainer< TValue >::TreeNodeType = TreeNode<ValueType>

Definition at line 47 of file itkTreeContainer.h.

◆ ValueType

template<typename TValue>

using itk::TreeContainer< TValue >::ValueType = TValue

Definition at line 46 of file itkTreeContainer.h.

Constructor & Destructor Documentation

◆ TreeContainer() [1/3]

template<typename TValue>

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

Constructor

◆ TreeContainer() [2/3]

template<typename TValue>

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

Constructor

◆ TreeContainer() [3/3]

template<typename TValue>

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

protected

◆ ~TreeContainer()

template<typename TValue>

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

overrideprotecteddefault

Member Function Documentation

◆ Add()

template<typename TValue>

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

Add a child to a given parent using values

◆ Clear()

template<typename TValue>

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

overridevirtual

Clear the tree

Implements itk::TreeContainerBase< TValue >.

◆ Contains()

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

◆ Count()

template<typename TValue>

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

overridevirtual

Return the number of elements in the tree

Implements itk::TreeContainerBase< TValue >.

◆ CreateAnother()

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.

◆ GetNameOfClass()

template<typename TValue>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::TreeContainerBase< TValue >.

◆ GetNode()

template<typename TValue>

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

Get node given a value

◆ GetRoot()

template<typename TValue>

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

inlineoverridevirtual

Get the root

Implements itk::TreeContainerBase< TValue >.

Definition at line 107 of file itkTreeContainer.h.

◆ IsLeaf()

template<typename TValue>

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

overridevirtual

Return true if the element is a leaf

Implements itk::TreeContainerBase< TValue >.

◆ IsRoot()

template<typename TValue>

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

overridevirtual

Return true if the element is a root

Implements itk::TreeContainerBase< TValue >.

◆ New()

template<typename TValue>

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

static

Method for creation through the object factory.

◆ operator==()

template<typename TValue>

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

operator equal

◆ PrintSelf()

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.

◆ SetRoot() [1/3]

template<typename TValue>

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

overridevirtual

Set the root as an element

Implements itk::TreeContainerBase< TValue >.

◆ SetRoot() [2/3]

template<typename TValue>

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

The the root as an iterator position

◆ SetRoot() [3/3]

template<typename TValue>

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

overridevirtual

Set the root as a tree node

Implements itk::TreeContainerBase< TValue >.

◆ Swap()

template<typename TValue>

bool itk::TreeContainer< TValue >::Swap	(	IteratorType &	v,
		IteratorType &	w
	)

Swap the iterators

Member Data Documentation

◆ m_DefaultChildrenCount

template<typename TValue>

int itk::TreeContainer< TValue >::m_DefaultChildrenCount

protected

Definition at line 126 of file itkTreeContainer.h.

◆ m_Root

template<typename TValue>

TreeNodeType::Pointer itk::TreeContainer< TValue >::m_Root

protected

Definition at line 124 of file itkTreeContainer.h.

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

itkTreeContainer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ IteratorType

◆ Pointer

◆ PreOrderIteratorType

◆ Self

◆ Superclass

◆ TreeNodeType

◆ ValueType

Constructor & Destructor Documentation

◆ TreeContainer() [1/3]

◆ TreeContainer() [2/3]

◆ TreeContainer() [3/3]

◆ ~TreeContainer()

Member Function Documentation

◆ Add()

◆ Clear()

◆ Contains()

◆ Count()

◆ CreateAnother()

◆ GetNameOfClass()

◆ GetNode()

◆ GetRoot()

◆ IsLeaf()

◆ IsRoot()

◆ New()

◆ operator==()

◆ PrintSelf()

◆ SetRoot() [1/3]

◆ SetRoot() [2/3]

◆ SetRoot() [3/3]

◆ Swap()

Member Data Documentation

◆ m_DefaultChildrenCount

◆ m_Root

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