ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::TreeContainer< TValueType > Class Template Reference

#include <itkTreeContainer.h>

+ Inheritance diagram for itk::TreeContainer< TValueType >:
+ Collaboration diagram for itk::TreeContainer< TValueType >:

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
TValueTypeElement type stored at each location in the Tree.

Definition at line 38 of file itkTreeContainer.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TreeIteratorBase< SelfIteratorType
 
typedef SmartPointer< SelfPointer
 
typedef PreOrderTreeIterator
< Self
PreOrderIteratorType
 
typedef TreeContainer< TValueType > Self
 
typedef TreeContainerBase
< TValueType > 
Superclass
 
typedef TreeNode< ValueTypeTreeNodeType
 
typedef TValueType ValueType
 
- Public Types inherited from itk::TreeContainerBase< TValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef TreeContainerBase Self
 
typedef Object Superclass
 
typedef TValueType 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

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 TreeNodeTypeGetNode (TValueType val) const
 
const TreeNodeTypeGetRoot () const
 
bool IsLeaf (const TValueType element)
 
bool IsRoot (const TValueType element)
 
bool operator== (TreeContainer< TValueType > &tree)
 
virtual bool SetRoot (const TValueType element)
 
bool SetRoot (IteratorType &pos)
 
virtual bool SetRoot (TreeNode< TValueType > *node)
 
bool Swap (IteratorType &v, IteratorType &w)
 
 TreeContainer (int defaultChildrenCount)
 
 TreeContainer (TreeContainer< TValueType > &tree)
 
- Public Member Functions inherited from itk::TreeContainerBase< TValueType >
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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () 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 ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

template<class TValueType>
typedef SmartPointer< const Self > itk::TreeContainer< TValueType >::ConstPointer

Definition at line 46 of file itkTreeContainer.h.

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

Iterators typedef

Definition at line 51 of file itkTreeContainer.h.

template<class TValueType>
typedef SmartPointer< Self > itk::TreeContainer< TValueType >::Pointer

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

Definition at line 44 of file itkTreeContainer.h.

template<class TValueType>
typedef TreeContainerBase< TValueType > itk::TreeContainer< TValueType >::Superclass

Standard typedefs

Definition at line 43 of file itkTreeContainer.h.

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

Definition at line 48 of file itkTreeContainer.h.

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

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

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.

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
inlinevirtual

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.

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
protectedvirtual

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>
virtual bool itk::TreeContainer< TValueType >::SetRoot ( const TValueType  element)
virtual

Set the root as an element

Implements itk::TreeContainerBase< TValueType >.

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>
bool itk::TreeContainer< TValueType >::Swap ( IteratorType v,
IteratorType w 
)

Swap the iterators

Member Data Documentation

template<class TValueType>
int itk::TreeContainer< TValueType >::m_DefaultChildrenCount
protected

Definition at line 112 of file itkTreeContainer.h.

template<class TValueType>
TreeNodeType::Pointer itk::TreeContainer< TValueType >::m_Root
protected

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