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

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

Light weight base class for most itk classes. More...

#include <itkLightObject.h>

Inheritance diagram for itk::LightObject:

[legend]Collaboration diagram for itk::LightObject:

[legend]List of all members.


Public Types
typedef LightObject	Self
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
virtual void	Delete ()
virtual const char *	GetNameOfClass () const
void	Print (std::ostream &os) const
virtual void	Register () const
virtual void	UnRegister () const
virtual int	GetReferenceCount () const
virtual void	SetReferenceCount (int)
Static Public Member Functions
Pointer	New ()
void	BreakOnError ()
Protected Member Functions
	LightObject ()
virtual	~LightObject ()

virtual void	PrintSelf (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
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Detailed Description

Light weight base class for most itk classes.

LightObject is the highest level base class for most itk objects. It implements reference counting and the API for object printing. It can be used as a lightweight base class in preference to Object. (LightObject does not support callbacks or modified time as Object does.) All ITK objects should be a subclass of LightObject or Object with few exceptions (due to performance concerns).

See also:: Object

Definition at line 51 of file itkLightObject.h.

Member Typedef Documentation

Constructor & Destructor Documentation

itk::LightObject::LightObject ( ) [inline, protected]

Definition at line 104 of file itkLightObject.h.

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

Member Function Documentation

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

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

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

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.

virtual const char* itk::LightObject::GetNameOfClass ( ) const [inline, virtual]

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information. Definition at line 70 of file itkLightObject.h.

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

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

void itk::LightObject::Print ( std::ostream & os ) const

Cause the object to print itself out.
Reimplemented in itk::MetaDataObject< MetaDataObjectType >, and itk::MetaDataObjectBase.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( 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.

virtual void itk::LightObject::PrintTrailer ( 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.

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

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

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

Sets the reference count on this object. This is a dangerous method, use it with care.
Reimplemented in itk::Object.

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

Decrease the reference count (release by another object).
Reimplemented in itk::Object.

Member Data Documentation

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

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

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

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

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

itkLightObject.h

Generated at Sun Apr 1 03:09:52 2007 for ITK by

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

Public Types

Public Member Functions

Static Public Member Functions