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

Base class for most itk classes. More...

#include <itkObject.h>

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 LightObject::Pointer CreateAnother () const

virtual const char * GetNameOfClass () 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 *)

unsigned long AddObserver (const EventObject &event, Command *) const

Command * GetCommand (unsigned long tag)

void InvokeEvent (const EventObject &)

void InvokeEvent (const EventObject &) const

void RemoveObserver (unsigned long tag)

void RemoveAllObservers ()

bool HasObserver (const EventObject &event) const

MetaDataDictionary & GetMetaDataDictionary (void)

const MetaDataDictionary & GetMetaDataDictionary (void) const

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void Delete ()

void Print (std::ostream &os, Indent indent=0) const

virtual int GetReferenceCount () const

Static Public Member Functions

static Pointer New ()

static void SetGlobalWarningDisplay (bool flag)

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOn ()

static void GlobalWarningDisplayOff ()

static void BreakOnError ()

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

Object ()

virtual void PrintSelf (std::ostream &os, Indent indent) const

bool PrintObservers (std::ostream &os, Indent indent) const

virtual void PrintHeader (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

Private Member Functions

Object (const Self &)

void operator= (const Self &)

Private Attributes

bool m_Debug

TimeStamp m_MTime

SubjectImplementation * m_SubjectImplementation

MetaDataDictionary * m_MetaDataDictionary

Static Private Attributes

static bool m_GlobalWarningDisplay = true

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

typedef Object itk::Object::Self

Smart pointer typedef support.

Reimplemented from itk::LightObject.

Definition at line 48 of file itkObject.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

Constructor & Destructor Documentation

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

Create an object with Debug turned off and modified time initialized to the most recently modified object.

Definition at line 492 of file itkObject.cxx.

References Modified().

00492         :
00493   LightObject(),
00494   m_Debug(false),
00495   m_SubjectImplementation(NULL),
00496   m_MetaDataDictionary(NULL)
00497 {
00498   this->Modified();
00499 }

Member Function Documentation

Object::Pointer itk::Object::New ( void ) [static]

Method for creation through the object factory.

Reimplemented from itk::LightObject.

Definition at line 217 of file itkObject.cxx.

References UnRegister().

Referenced by CreateAnother(), itk::ProcessObject::MakeOutput(), itk::MultipleValuedVnlCostFunctionAdaptor::MultipleValuedVnlCostFunctionAdaptor(), and itk::SingleValuedVnlCostFunctionAdaptor::SingleValuedVnlCostFunctionAdaptor().

00218 {
00219   Pointer smartPtr;
00220   Object *rawPtr = ::itk::ObjectFactory<Object>::Create();
00221   if(rawPtr == NULL)
00222     {
00223     rawPtr = new Object;
00224     }
00225   smartPtr = rawPtr;
00226   rawPtr->UnRegister();
00227   return smartPtr;
00228 }

LightObject::Pointer itk::Object::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::LightObject.

Definition at line 231 of file itkObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and New().

00232 {
00233   return Object::New().GetPointer();
00234 }

virtual const char* itk::Object::GetNameOfClass ( ) const [virtual]

Standard part of all itk objects.

Reimplemented from itk::LightObject.

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

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

References m_Debug.

00243 {
00244   m_Debug = true;
00245 }

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

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

References m_Debug.

00254 {
00255   m_Debug = false;
00256 }

bool itk::Object::GetDebug ( ) const

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

References m_Debug.

00265 {
00266   return m_Debug;
00267 }

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

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

Definition at line 275 of file itkObject.cxx.

References m_Debug.

00276 {
00277   m_Debug = debugFlag;
00278 }

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

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

References itk::TimeStamp::GetMTime(), and m_MTime.

Referenced by itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), PrintSelf(), and itk::ProcessObject::UpdateOutputInformation().

00287 {
00288   return m_MTime.GetMTime();
00289 }

void itk::Object::Modified ( void ) 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.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

References InvokeEvent(), m_MTime, and itk::TimeStamp::Modified().

00298 {
00299   m_MTime.Modified();
00300   InvokeEvent( ModifiedEvent() );
00301 }

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

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

References itk::LightObject::m_ReferenceCount, and itk::LightObject::Register().

Referenced by itk::ObjectFactoryBase::RegisterFactory().

00310 {
00311   itkDebugMacro(<< "Registered, "
00312                 << "ReferenceCount = " << (m_ReferenceCount+1));
00313 
00314   // call the parent
00315   Superclass::Register();
00316 }

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

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

References InvokeEvent(), itk::LightObject::m_ReferenceCount, and itk::LightObject::UnRegister().

Referenced by New(), itk::SmartPointer< itk::Statistics::ImageToListAdaptor >::operator=(), and itk::ObjectFactoryBase::UnRegisterFactory().

00325 {
00326   // call the parent
00327   itkDebugMacro(<< "UnRegistered, "
00328                 << "ReferenceCount = " << (m_ReferenceCount-1));
00329 
00330   if ( (m_ReferenceCount-1) <= 0)
00331     {
00335     this->InvokeEvent(DeleteEvent());
00336     }
00337 
00338   Superclass::UnRegister();
00339 }

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

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

References InvokeEvent(), and itk::LightObject::SetReferenceCount().

00348 {
00349   itkDebugMacro(<< "Reference Count set to " << ref);
00350 
00351   // ReferenceCount in now unlocked.  We may have a race condition to
00352   // to delete the object.
00353   if( ref <= 0 )
00354     {
00358     this->InvokeEvent(DeleteEvent());
00359     }
00360 
00361   Superclass::SetReferenceCount(ref);
00362 }

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

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

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

References m_GlobalWarningDisplay.

00371 {
00372   m_GlobalWarningDisplay = val;
00373 }

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

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

References m_GlobalWarningDisplay.

00382 {
00383   return m_GlobalWarningDisplay;
00384 }

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

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

Definition at line 389 of file itkObject.cxx.

References m_SubjectImplementation.

Referenced by itk::ProgressAccumulator::RegisterInternalFilter(), and otb::WriterWatcherBase::WriterWatcherBase().

00390 {
00391   if (!this->m_SubjectImplementation)
00392     {
00393     this->m_SubjectImplementation = new SubjectImplementation;
00394     }
00395   return this->m_SubjectImplementation->AddObserver(event,cmd);
00396 }

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.

Definition at line 414 of file itkObject.cxx.

References m_SubjectImplementation.

00415 {
00416   if (this->m_SubjectImplementation)
00417     {
00418     return this->m_SubjectImplementation->GetCommand(tag);
00419     }
00420   return NULL;
00421 }

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

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

References m_SubjectImplementation.

Referenced by Modified(), SetReferenceCount(), itk::CumulativeGaussianOptimizer::StartOptimization(), UnRegister(), and itk::VTKImageExportBase::UpdateDataCallback().

00447 {
00448   if (this->m_SubjectImplementation)
00449     {
00450     this->m_SubjectImplementation->InvokeEvent(event,this);
00451     }
00452 }

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

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

Definition at line 457 of file itkObject.cxx.

References m_SubjectImplementation.

00458 {
00459   if (this->m_SubjectImplementation)
00460     {
00461     this->m_SubjectImplementation->InvokeEvent(event,this);
00462     }
00463 }

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

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

References m_SubjectImplementation.

00426 {
00427   if (this->m_SubjectImplementation)
00428     {
00429     this->m_SubjectImplementation->RemoveObserver(tag);
00430     }
00431 }

void itk::Object::RemoveAllObservers ( )

Remove all observers .

Definition at line 435 of file itkObject.cxx.

References m_SubjectImplementation.

00436 {
00437   if (this->m_SubjectImplementation)
00438     {
00439     this->m_SubjectImplementation->RemoveAllObservers();
00440     }
00441 }

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

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

References m_SubjectImplementation.

00468 {
00469   if (this->m_SubjectImplementation)
00470     {
00471     return this->m_SubjectImplementation->HasObserver(event);
00472     }
00473   return false;
00474 }

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References m_MetaDataDictionary.

00533 {
00534   if(m_MetaDataDictionary==NULL)
00535     {
00536     m_MetaDataDictionary=new MetaDataDictionary;
00537     }
00538   return *m_MetaDataDictionary;
00539 }

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

Returns:: A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References m_MetaDataDictionary.

00544 {
00545   if(m_MetaDataDictionary==NULL)
00546     {
00547     m_MetaDataDictionary=new MetaDataDictionary;
00548     }
00549   return *m_MetaDataDictionary;
00550 }

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

Returns:: Set the MetaDataDictionary

Definition at line 554 of file itkObject.cxx.

References m_MetaDataDictionary.

Referenced by otb::Image< TPixel, VImageDimension >::CopyInformation(), and otb::VectorImage< TPixel, VImageDimension >::CopyInformation().

00555 {
00556   if(m_MetaDataDictionary==NULL)
00557     {
00558     m_MetaDataDictionary=new MetaDataDictionary;
00559     }
00560   *m_MetaDataDictionary=rhs;
00561 }

void itk::Object::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::LightObject.

Definition at line 517 of file itkObject.cxx.

References GetMTime(), itk::Indent::GetNextIndent(), m_Debug, and itk::LightObject::PrintSelf().

00518 {
00519   Superclass::PrintSelf(os, indent);
00520 
00521   os << indent << "Modified Time: " << this->GetMTime() << std::endl;
00522   os << indent << "Debug: " << (m_Debug ? "On\n" : "Off\n");
00523   os << indent << "Observers: \n";
00524   if(!this->PrintObservers(os, indent.GetNextIndent()))
00525     {
00526     os << indent.GetNextIndent() << "none\n";
00527     }
00528 }

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.

Delete a 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.

Definition at line 88 of file itkLightObject.cxx.

References itk::LightObject::UnRegister().

00089 {
00090   this->UnRegister();
00091 }

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent(), itk::LightObject::PrintHeader(), itk::LightObject::PrintSelf(), and itk::LightObject::PrintTrailer().

Referenced by itk::operator<<(), itk::WeakPointer< itk::ProcessObject >::Print(), and itk::SmartPointer< itk::Statistics::ImageToListAdaptor >::Print().

00136 {
00137   this->PrintHeader(os, indent); 
00138   this->PrintSelf(os, indent.GetNextIndent());
00139   this->PrintTrailer(os, indent);
00140 }

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

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

Definition at line 149 of file itkLightObject.cxx.

00150 {
00151   ;  
00152 }

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

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

00106     {return static_cast<int>(m_ReferenceCount);}

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

References itk::LightObject::GetNameOfClass().

Referenced by itk::LightObject::Print().

00321 {
00322   os << indent << this->GetNameOfClass() << " (" << this << ")\n";
00323 }

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

Referenced by itk::LightObject::Print().

00332 {
00333 }

Member Data Documentation

bool itk::Object::m_Debug [mutable, private]

Enable/Disable debug messages.

Definition at line 171 of file itkObject.h.

Referenced by DebugOff(), DebugOn(), GetDebug(), PrintSelf(), and SetDebug().

TimeStamp itk::Object::m_MTime [mutable, private]

Keep track of modification time.

Definition at line 174 of file itkObject.h.

Referenced by GetMTime(), and Modified().

bool itk::Object::m_GlobalWarningDisplay = true [static, private]

Global object debug flag.

Initialize static member that controls warning display.

Definition at line 177 of file itkObject.h.

Referenced by GetGlobalWarningDisplay(), and SetGlobalWarningDisplay().

SubjectImplementation* itk::Object::m_SubjectImplementation [private]

Implementation class for Subject/Observer Pattern. This is only allocated if used.

Definition at line 181 of file itkObject.h.

Referenced by AddObserver(), GetCommand(), HasObserver(), InvokeEvent(), RemoveAllObservers(), and RemoveObserver().

MetaDataDictionary* itk::Object::m_MetaDataDictionary [mutable, private]

Implementation for holding Object MetaData

See also:

itk::MetaDataDictionary

itk::MetaDataObjectBase

itk::MetaDataObject This is only allocated if used.

Definition at line 189 of file itkObject.h.

Referenced by GetMetaDataDictionary(), and SetMetaDataDictionary().

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

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

Referenced by itk::LightObject::PrintSelf(), itk::LightObject::Register(), Register(), itk::LightObject::SetReferenceCount(), itk::LightObject::UnRegister(), UnRegister(), and itk::LightObject::~LightObject().

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

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

Referenced by itk::LightObject::Register(), itk::LightObject::SetReferenceCount(), and itk::LightObject::UnRegister().

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


Public Types
typedef Object	Self
typedef LightObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () 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 *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Command *	GetCommand (unsigned long tag)
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
void	RemoveObserver (unsigned long tag)
void	RemoveAllObservers ()
bool	HasObserver (const EventObject &event) const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	Delete ()
void	Print (std::ostream &os, Indent indent=0) const
virtual int	GetReferenceCount () const
Static Public Member Functions
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	BreakOnError ()
Protected Types
typedef int	InternalReferenceCountType
Protected Member Functions
	Object ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Private Member Functions
	Object (const Self &)
void	operator= (const Self &)
Private Attributes
bool	m_Debug
TimeStamp	m_MTime
SubjectImplementation *	m_SubjectImplementation
MetaDataDictionary *	m_MetaDataDictionary
Static Private Attributes
static bool	m_GlobalWarningDisplay = true

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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