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

itk::Object Class Reference
[ITK System Objects, Data Representation Objects]

Base class for most itk classes. More...

#include <itkObject.h>

Inheritance diagram for itk::Object:

[legend]Collaboration diagram for itk::Object:

[legend]List of all members.


Public Types
typedef Object	Self
typedef LightObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual void	DebugOn () const
virtual void	DebugOff () const
bool	GetDebug () const
void	SetDebug (bool debugFlag) const
virtual unsigned long	GetMTime () const
virtual void	Modified () const
virtual void	Register () const
virtual void	UnRegister () const
virtual void	SetReferenceCount (int)
unsigned long	AddObserver (const EventObject &event, Command *)
Command *	GetCommand (unsigned long tag)
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
void	RemoveObserver (unsigned long tag)
bool	HasObserver (const EventObject &event) const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Static Public Member Functions
Pointer	New ()

void	SetGlobalWarningDisplay (bool flag)
bool	GetGlobalWarningDisplay ()
void	GlobalWarningDisplayOn ()
void	GlobalWarningDisplayOff ()
Protected Member Functions
	Object ()
virtual	~Object ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const

Detailed Description

Base class for most itk classes.

Object is the second-highest level base class for most itk objects. It extends the base object functionality of LightObject by implementing callbacks (via object/observer), debug flags/methods, and modification time tracking. Most ITK classes should be a subclas of Object due to the need to keep track of modified time.

Definition at line 44 of file itkObject.h.

Member Typedef Documentation

Constructor & Destructor Documentation

itk::Object::Object ( ) [protected]

virtual itk::Object::~Object ( ) [protected, virtual]

Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject & event,

Command *

)

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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

Turn debugging output off.

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

Turn debugging output on.

Command* itk::Object::GetCommand ( unsigned long tag )

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

Get the value of the debug flag.

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

This is a global flag that controls whether any debug, warning or error messages are displayed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void )

Returns:
A reference to this objects MetaDataDictionary.

Warning:
This reference may be changed.

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

Return this objects modified time.
Reimplemented in itk::ResampleImageFilter< TInputImage, TOutputImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageSpatialObject< TDimension, PixelType >, itk::SceneSpatialObject< SpaceDimension >, itk::SpatialObject< TDimension >, itk::SceneSpatialObject< NDimensions >, and itk::SpatialObject< NDimensions >.

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

This is a global flag that controls whether any debug, warning or error messages are displayed. Definition at line 93 of file itkObject.h.

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

This is a global flag that controls whether any debug, warning or error messages are displayed. Definition at line 91 of file itkObject.h.

bool itk::Object::HasObserver ( const EventObject & event ) const

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const

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 & )

Call Execute on all the Commands observing this event id.

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

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::AffineTransform< TScalarType, NDimensions >::GetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::AffineTransform< TScalarType, NDimensions >::SetOffset(), and itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale().

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

Indent indent

) const [protected]

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

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

void itk::Object::RemoveObserver ( unsigned long tag )

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const

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

void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static]

This is a global flag that controls whether any debug, warning or error messages are displayed.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

Returns:
Set the MetaDataDictionary

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

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

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

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

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

itkObject.h

Generated at Sat Mar 31 02:58:34 2007 for ITK by

itk::Object Class Reference [ITK System Objects, Data Representation Objects]

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

itk::Object Class Reference
[ITK System Objects, Data Representation Objects]