ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::TreeNode< TValueType > Class Template Reference

#include <itkTreeNode.h>

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

List of all members.

Public Types

typedef ::itk::OffsetValueType ChildIdentifier
typedef std::vector< PointerChildrenListType
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef TreeNode< TValueType > Self
typedef Object Superclass

Public Member Functions

void AddChild (TreeNode< TValueType > *node)
virtual void AddChild (ChildIdentifier number, TreeNode< TValueType > *node)
ChildIdentifier ChildPosition (const TreeNode< TValueType > *node) const
ChildIdentifier ChildPosition (TValueType node) const
ChildIdentifier CountChildren () const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
const TValueType & Get () const
TreeNode< TValueType > * GetChild (ChildIdentifier number) const
virtual ChildrenListTypeGetChildren (unsigned int depth=0, char *name=NULL) const
virtual ChildrenListTypeGetChildrenList ()
virtual const char * GetNameOfClass () const
ChildIdentifier GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
TreeNode< TValueType > * GetParent () const
bool HasChildren () const
bool HasParent () const
bool Remove (TreeNode< TValueType > *n)
bool ReplaceChild (TreeNode< TValueType > *oldChild, TreeNode< TValueType > *newChild)
TValueType Set (const TValueType data)
void SetParent (TreeNode< TValueType > *n)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 TreeNode ()
virtual ~TreeNode ()

Protected Attributes

ChildrenListType m_Children
TValueType m_Data
Selfm_Parent

Private Member Functions

void operator= (const Self &)
 TreeNode (const Self &)

Detailed Description

template<class TValueType>
class itk::TreeNode< TValueType >

Represents a node in a tree.

This class derives from the Object class.

The class is templated over the type of the elements.

Template Parameters:
TValueType= Element type stored in the node

Definition at line 43 of file itkTreeNode.h.


Member Typedef Documentation

template<class TValueType>
typedef ::itk::OffsetValueType itk::TreeNode< TValueType >::ChildIdentifier

Definition at line 53 of file itkTreeNode.h.

template<class TValueType>
typedef std::vector< Pointer > itk::TreeNode< TValueType >::ChildrenListType

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

Definition at line 52 of file itkTreeNode.h.

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

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

Definition at line 51 of file itkTreeNode.h.

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

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

Definition at line 50 of file itkTreeNode.h.

template<class TValueType>
typedef TreeNode< TValueType > itk::TreeNode< TValueType >::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

Definition at line 49 of file itkTreeNode.h.

template<class TValueType>
typedef Object itk::TreeNode< TValueType >::Superclass

Standard typedefs

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

Definition at line 48 of file itkTreeNode.h.


Constructor & Destructor Documentation

template<class TValueType>
itk::TreeNode< TValueType >::TreeNode ( ) [protected]

Set the data of the node

template<class TValueType>
virtual itk::TreeNode< TValueType >::~TreeNode ( ) [protected, virtual]
template<class TValueType>
itk::TreeNode< TValueType >::TreeNode ( const Self ) [private]

Member Function Documentation

template<class TValueType>
void itk::TreeNode< TValueType >::AddChild ( TreeNode< TValueType > *  node)

Add a child to the node

template<class TValueType>
virtual void itk::TreeNode< TValueType >::AddChild ( ChildIdentifier  number,
TreeNode< TValueType > *  node 
) [virtual]

Add a child to the node and specify the number in the children list

template<class TValueType>
ChildIdentifier itk::TreeNode< TValueType >::ChildPosition ( const TreeNode< TValueType > *  node) const

Return the child position given a node

template<class TValueType>
ChildIdentifier itk::TreeNode< TValueType >::ChildPosition ( TValueType  node) const

Return the child position given a value

template<class TValueType>
ChildIdentifier itk::TreeNode< TValueType >::CountChildren ( ) const

Return the number of children

template<class TValueType>
virtual::itk::LightObject::Pointer itk::TreeNode< 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.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

template<class TValueType>
const TValueType& itk::TreeNode< TValueType >::Get ( ) const

Get the value of the node

template<class TValueType>
TreeNode< TValueType >* itk::TreeNode< TValueType >::GetChild ( ChildIdentifier  number) const

Get the child node

template<class TValueType>
virtual ChildrenListType* itk::TreeNode< TValueType >::GetChildren ( unsigned int  depth = 0,
char *  name = NULL 
) const [virtual]

Get the children list

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

template<class TValueType>
virtual ChildrenListType& itk::TreeNode< TValueType >::GetChildrenList ( ) [inline, virtual]

Get the internal list of children

Definition at line 114 of file itkTreeNode.h.

template<class TValueType>
virtual const char* itk::TreeNode< TValueType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

template<class TValueType>
ChildIdentifier itk::TreeNode< TValueType >::GetNumberOfChildren ( unsigned int  depth = 0,
char *  name = NULL 
) const

Get the number of children given a name and depth

template<class TValueType>
TreeNode< TValueType >* itk::TreeNode< TValueType >::GetParent ( ) const

Get the parent node

template<class TValueType>
bool itk::TreeNode< TValueType >::HasChildren ( ) const

Return true if the node has children

template<class TValueType>
bool itk::TreeNode< TValueType >::HasParent ( ) const

Return true if the node has a parent

template<class TValueType>
static Pointer itk::TreeNode< TValueType >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

template<class TValueType>
void itk::TreeNode< TValueType >::operator= ( const Self ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

Reimplemented in itk::SpatialObjectTreeNode< TDimension >.

template<class TValueType>
bool itk::TreeNode< TValueType >::Remove ( TreeNode< TValueType > *  n)

Remove a node from the node

template<class TValueType>
bool itk::TreeNode< TValueType >::ReplaceChild ( TreeNode< TValueType > *  oldChild,
TreeNode< TValueType > *  newChild 
)

Replace a given child by a new one

template<class TValueType>
TValueType itk::TreeNode< TValueType >::Set ( const TValueType  data)

Set the current value of the node

template<class TValueType>
void itk::TreeNode< TValueType >::SetParent ( TreeNode< TValueType > *  n)

Set the parent of the node


Member Data Documentation

template<class TValueType>
ChildrenListType itk::TreeNode< TValueType >::m_Children [protected]
template<class TValueType>
TValueType itk::TreeNode< TValueType >::m_Data [protected]

Definition at line 123 of file itkTreeNode.h.

template<class TValueType>
Self* itk::TreeNode< TValueType >::m_Parent [protected]

Definition at line 125 of file itkTreeNode.h.


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