Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::TreeContainerBase< TValueType > Class Template Reference

#include <itkTreeContainerBase.h>

Inheritance diagram for itk::TreeContainerBase< TValueType >:

[legend]Collaboration diagram for itk::TreeContainerBase< TValueType >:

[legend]List of all members.

template<class TValueType>
class itk::TreeContainerBase< TValueType >


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef TreeContainerBase	Self
typedef Object	Superclass
typedef TValueType	ValueType
Public Member Functions
virtual bool	Clear ()=0
virtual bool	Contains (const TValueType element)=0
virtual int	Count () const =0
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
virtual const TreeNode< TValueType > *	GetRoot () const =0
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual bool	IsLeaf (const TValueType element)=0
virtual bool	IsRoot (const TValueType element)=0
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) 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 bool	SetRoot (TreeNode< TValueType > *node)=0
virtual bool	SetRoot (TValueType element)=0
void	SetSubtree (bool val)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning or error messages are displayed static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK object.This is an implementation of the subject/observer design pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	TreeContainerBase ()
virtual	~TreeContainerBase ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_SubTree
Methods invoked by virtual 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./virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

Member Typedef Documentation

template<class TValueType>

typedef SmartPointer<const Self> itk::TreeContainerBase< TValueType >::ConstPointer

Reimplemented from itk::Object.
Reimplemented in itk::TreeContainer< TValueType >, itk::SpatialObjectTreeContainer< TDimension >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.
Definition at line 39 of file itkTreeContainerBase.h.

template<class TValueType>

typedef SmartPointer<Self> itk::TreeContainerBase< TValueType >::Pointer

Reimplemented from itk::Object.
Reimplemented in itk::TreeContainer< TValueType >, itk::SpatialObjectTreeContainer< TDimension >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.
Definition at line 38 of file itkTreeContainerBase.h.

template<class TValueType>

typedef TreeContainerBase itk::TreeContainerBase< TValueType >::Self

Smart pointer typedef support.
Reimplemented from itk::Object.
Reimplemented in itk::TreeContainer< TValueType >, itk::SpatialObjectTreeContainer< TDimension >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.
Definition at line 37 of file itkTreeContainerBase.h.

template<class TValueType>

typedef Object itk::TreeContainerBase< TValueType >::Superclass

Reimplemented from itk::Object.
Reimplemented in itk::TreeContainer< TValueType >, itk::SpatialObjectTreeContainer< TDimension >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.
Definition at line 36 of file itkTreeContainerBase.h.

template<class TValueType>

typedef TValueType itk::TreeContainerBase< TValueType >::ValueType

Reimplemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.
Definition at line 41 of file itkTreeContainerBase.h.

Constructor & Destructor Documentation

template<class TValueType>

itk::TreeContainerBase< TValueType >::TreeContainerBase ( ) [inline, protected]

Definition at line 76 of file itkTreeContainerBase.h.

template<class TValueType>

virtual itk::TreeContainerBase< TValueType >::~TreeContainerBase ( ) [inline, protected, virtual]

Definition at line 77 of file itkTreeContainerBase.h.

Member Function Documentation

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<class TValueType>

virtual bool itk::TreeContainerBase< TValueType >::Clear ( ) [pure virtual]

Clear the tree
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<class TValueType>

virtual bool itk::TreeContainerBase< TValueType >::Contains ( const TValueType element ) [pure virtual]

Return true if the tree contains the element
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<class TValueType>

virtual int itk::TreeContainerBase< TValueType >::Count ( ) const [pure virtual]

Return the number of nodes in the tree
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:
A reference to this objects MetaDataDictionary.

Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.
Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TValueType>

virtual const char* itk::TreeContainerBase< TValueType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).
Reimplemented from itk::Object.
Reimplemented in itk::TreeContainer< TValueType >, itk::SpatialObjectTreeContainer< TDimension >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.
Definition at line 98 of file itkLightObject.h.

template<class TValueType>

virtual const TreeNode<TValueType>* itk::TreeContainerBase< TValueType >::GetRoot ( ) const [pure virtual]

Get the root as a node
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.
References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<class TValueType>

virtual bool itk::TreeContainerBase< TValueType >::IsLeaf ( const TValueType element ) [pure virtual]

Return if the element is a leaf
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<class TValueType>

virtual bool itk::TreeContainerBase< TValueType >::IsRoot ( const TValueType element ) [pure virtual]

Return if the element is root
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

void itk::LightObject::Print ( std::ostream & os,

Indent indent = 0

) const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers ( std::ostream & os,

Indent indent

) const [protected, inherited]

virtual void itk::LightObject::PrintTrailer ( std::ostream & os,

Indent indent

) const [protected, virtual, inherited]

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).
Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:
Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)
Reimplemented from itk::LightObject.

template<class TValueType>

virtual bool itk::TreeContainerBase< TValueType >::SetRoot ( TreeNode< TValueType > * node ) [pure virtual]

Set the root has a node
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<class TValueType>

virtual bool itk::TreeContainerBase< TValueType >::SetRoot ( TValueType element ) [pure virtual]

Set the root element. A new node is created and the element is added to the node
Implemented in itk::TreeContainer< TValueType >, and itk::TreeContainer< itk::SpatialObject< TDimension > * >.

template<class TValueType>

void itk::TreeContainerBase< TValueType >::SetSubtree ( bool val ) [inline]

Set if the tree is a subtree
Definition at line 72 of file itkTreeContainerBase.h.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).
Reimplemented from itk::LightObject.

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.
Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count
Definition at line 122 of file itkLightObject.h.

template<class TValueType>

bool itk::TreeContainerBase< TValueType >::m_SubTree [protected]

Definition at line 77 of file itkTreeContainerBase.h.
Referenced by itk::TreeContainerBase< itk::SpatialObject< TDimension > * >::SetSubtree().

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

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

itkTreeContainerBase.h

Generated at Sun Jul 9 21:41:55 2006 for ITK by

itk::TreeContainerBase< TValueType > Class Template Reference

template<class TValueType> class itk::TreeContainerBase< TValueType >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TValueType>
class itk::TreeContainerBase< TValueType >