#include <itkLightObject.h>

Inheritance diagram for itk::LightObject:

Collaboration diagram for itk::LightObject:

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

typedef int	InternalReferenceCountType
Protected Member Functions
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
	LightObject (const Self &)
void	operator= (const Self &)

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 54 of file itkLightObject.h.

Member Typedef Documentation

typedef SmartPointer< const Self > itk::LightObject::ConstPointer

Definition at line 60 of file itkLightObject.h.

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

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

Definition at line 151 of file itkLightObject.h.

typedef SmartPointer< Self > itk::LightObject::Pointer

Definition at line 59 of file itkLightObject.h.

typedef LightObject itk::LightObject::Self

Standard class typedefs.

Definition at line 58 of file itkLightObject.h.

Constructor & Destructor Documentation

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

Definition at line 119 of file itkLightObject.h.

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

itk::LightObject::LightObject ( const Self & ) [private]

Mutex lock to protect modification to the reference count

Member Function Documentation

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

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

virtual Pointer itk::LightObject::CreateAnother ( ) 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.

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 82 of file itkLightObject.h.

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

Gets the reference count on this object.

Definition at line 111 of file itkLightObject.h.

virtual LightObject::Pointer itk::LightObject::InternalClone ( ) const [protected, virtual]

Actual implementation of the clone method. This method should be reimplemeted in subclasses to clone the extra required parameters.

Reimplemented in itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, 3, 2 >, itk::Transform< TScalar, NDimensions, NDimensions >, itk::CompositeTransform< TScalar, NDimensions >, itk::TimeVaryingVelocityFieldTransform< TScalar, NDimensions >, itk::BSplineSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >, itk::Statistics::MahalanobisDistanceMembershipFunction< TVector >, itk::Statistics::GaussianMembershipFunction< TMeasurementVector >, itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TScalar, NDimensions >, itk::Statistics::DistanceToCentroidMembershipFunction< TVector >, and itk::AffineGeometryFrame< TScalarType, NDimensions >.

itk::LightObject::itkCloneMacro ( Self )

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, 3, 2 >, itk::Transform< TScalar, NDimensions, NDimensions >, and itk::BSplineBaseTransform< TScalarType, NDimensions, VSplineOrder >.

static Pointer itk::LightObject::New ( ) [static]

Method for creation through the object factory.

Referenced by itk::RegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::SetFunctionCount().

void itk::LightObject::operator= ( const Self & ) [private]

Mutex lock to protect modification to the reference count

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

Cause the object to print itself out.

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

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

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

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

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

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

Number of uses of this object by other objects.

Definition at line 156 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 159 of file itkLightObject.h.

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

itkLightObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation