#include <itkTreeContainerBase.h>

Inheritance diagram for itk::TreeContainerBase< TValue >:

Collaboration diagram for itk::TreeContainerBase< TValue >:

Public Types
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
virtual bool	Clear ()=0

virtual bool	Contains (const TValue element)=0

virtual int	Count () const =0

virtual const char *	GetNameOfClass () const

virtual const TreeNode< TValue > *	GetRoot () const =0

virtual bool	IsLeaf (const TValue element)=0

virtual bool	IsRoot (const TValue element)=0

virtual bool	SetRoot (const TValue element)=0

virtual bool	SetRoot (TreeNode< TValue > *node)=0

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

LightObject::Pointer	CreateAnother () const override

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

Protected Member Functions
	TreeContainerBase ()

	~TreeContainerBase () override=default

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

	~Object () override

void	PrintSelf (std::ostream &os, Indent indent) const 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
bool	m_SubTree { false }

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

Additional Inherited Members
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 ()

Detailed Description

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

A base class for tree containers.

Definition at line 34 of file itkTreeContainerBase.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TValue >

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

Definition at line 40 of file itkTreeContainerBase.h.

◆ Pointer

template<typename TValue >

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

Definition at line 39 of file itkTreeContainerBase.h.

◆ Self

template<typename TValue >

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

Definition at line 38 of file itkTreeContainerBase.h.

◆ Superclass

template<typename TValue >

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

Definition at line 37 of file itkTreeContainerBase.h.

◆ ValueType

template<typename TValue >

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

Definition at line 42 of file itkTreeContainerBase.h.

Constructor & Destructor Documentation

◆ TreeContainerBase()

template<typename TValue >

itk::TreeContainerBase< TValue >::TreeContainerBase ( )

inlineprotected

Definition at line 88 of file itkTreeContainerBase.h.

◆ ~TreeContainerBase()

template<typename TValue >

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

overrideprotecteddefault

Member Function Documentation

◆ Clear()

template<typename TValue >

virtual bool itk::TreeContainerBase< TValue >::Clear ( )

pure virtual

Clear the tree

Implemented in itk::TreeContainer< TValue >.

◆ Contains()

template<typename TValue >

virtual bool itk::TreeContainerBase< TValue >::Contains ( const TValue element )

pure virtual

Return true if the tree contains the element

Implemented in itk::TreeContainer< TValue >.

◆ Count()

template<typename TValue >

virtual int itk::TreeContainerBase< TValue >::Count ( ) const

pure virtual

Return the number of nodes in the tree

Implemented in itk::TreeContainer< TValue >.

◆ GetNameOfClass()

template<typename TValue >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::TreeContainer< TValue >.

◆ GetRoot()

template<typename TValue >

virtual const TreeNode<TValue>* itk::TreeContainerBase< TValue >::GetRoot ( ) const

pure virtual

Get the root as a node

Implemented in itk::TreeContainer< TValue >.

◆ IsLeaf()

template<typename TValue >

virtual bool itk::TreeContainerBase< TValue >::IsLeaf ( const TValue element )

pure virtual

Return if the element is a leaf

Implemented in itk::TreeContainer< TValue >.

◆ IsRoot()

template<typename TValue >

virtual bool itk::TreeContainerBase< TValue >::IsRoot ( const TValue element )

pure virtual

Return if the element is root

Implemented in itk::TreeContainer< TValue >.

◆ SetRoot() [1/2]

template<typename TValue >

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

pure virtual

Set the root element. A new node is created and the element is added to the node

Implemented in itk::TreeContainer< TValue >.

◆ SetRoot() [2/2]

template<typename TValue >

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

pure virtual

Set the root has a node

Implemented in itk::TreeContainer< TValue >.

◆ SetSubtree()

template<typename TValue >

void itk::TreeContainerBase< TValue >::SetSubtree ( bool val )

inline

Set if the tree is a subtree

Definition at line 82 of file itkTreeContainerBase.h.

References itk::TreeContainerBase< TValue >::m_SubTree.

Member Data Documentation

◆ m_SubTree

template<typename TValue >

bool itk::TreeContainerBase< TValue >::m_SubTree { false }

protected

Definition at line 90 of file itkTreeContainerBase.h.

Referenced by itk::TreeContainerBase< TValue >::SetSubtree().

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

itkTreeContainerBase.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ TreeContainerBase()

◆ ~TreeContainerBase()

Member Function Documentation

◆ Clear()

◆ Contains()

◆ Count()

◆ GetNameOfClass()

◆ GetRoot()

◆ IsLeaf()

◆ IsRoot()

◆ SetRoot() [1/2]

◆ SetRoot() [2/2]

◆ SetSubtree()

Member Data Documentation

◆ m_SubTree

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