ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TreeContainerBase< TValue > Class Template Referenceabstract

#include <itkTreeContainerBase.h>

+ Inheritance diagram for itk::TreeContainerBase< TValue >:
+ Collaboration diagram for itk::TreeContainerBase< TValue >:

Detailed Description

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

A base class for tree containers.

Definition at line 34 of file itkTreeContainerBase.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef TreeContainerBase Self
 
typedef Object Superclass
 
typedef TValue ValueType
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

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
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
 

Protected Member Functions

 TreeContainerBase ()
 
virtual ~TreeContainerBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
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

bool m_SubTree
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< 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 ()
 

Member Typedef Documentation

template<typename TValue>
typedef SmartPointer< const Self > itk::TreeContainerBase< TValue >::ConstPointer

Definition at line 41 of file itkTreeContainerBase.h.

template<typename TValue>
typedef SmartPointer< Self > itk::TreeContainerBase< TValue >::Pointer

Definition at line 40 of file itkTreeContainerBase.h.

template<typename TValue>
typedef TreeContainerBase itk::TreeContainerBase< TValue >::Self

Definition at line 39 of file itkTreeContainerBase.h.

template<typename TValue>
typedef Object itk::TreeContainerBase< TValue >::Superclass

Definition at line 38 of file itkTreeContainerBase.h.

template<typename TValue>
typedef TValue itk::TreeContainerBase< TValue >::ValueType

Definition at line 43 of file itkTreeContainerBase.h.

Constructor & Destructor Documentation

template<typename TValue>
itk::TreeContainerBase< TValue >::TreeContainerBase ( )
inlineprotected

Definition at line 78 of file itkTreeContainerBase.h.

template<typename TValue>
virtual itk::TreeContainerBase< TValue >::~TreeContainerBase ( )
inlineprotectedvirtual

Definition at line 79 of file itkTreeContainerBase.h.

Member Function Documentation

template<typename TValue>
virtual bool itk::TreeContainerBase< TValue >::Clear ( )
pure virtual
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 >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

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 >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

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::SpatialObjectTreeContainer< TDimension >, itk::TreeContainer< TValue >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<typename TValue>
virtual const TreeNode< TValue >* itk::TreeContainerBase< TValue >::GetRoot ( ) const
pure virtual
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 >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<typename TValue>
virtual bool itk::TreeContainerBase< TValue >::IsRoot ( const TValue  element)
pure virtual
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 >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<typename TValue>
virtual bool itk::TreeContainerBase< TValue >::SetRoot ( TreeNode< TValue > *  node)
pure virtual
template<typename TValue>
void itk::TreeContainerBase< TValue >::SetSubtree ( bool  val)
inline

Set if the tree is a subtree

Definition at line 74 of file itkTreeContainerBase.h.

Member Data Documentation

template<typename TValue>
bool itk::TreeContainerBase< TValue >::m_SubTree
protected

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