#include <itkLightObject.h>

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

ITK Sphinx Examples:

All ITK Sphinx Examples

Get Name Of Class

Definition at line 55 of file itkLightObject.h.

Inheritance diagram for itk::LightObject:

Collaboration diagram for itk::LightObject:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static void	BreakOnError ()

static Pointer	New ()

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
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

using itk::LightObject::ConstPointer = SmartPointer<const Self>

Definition at line 63 of file itkLightObject.h.

◆ Pointer

using itk::LightObject::Pointer = SmartPointer<Self>

Definition at line 62 of file itkLightObject.h.

◆ Self

using itk::LightObject::Self = LightObject

Standard class type aliases.

Definition at line 61 of file itkLightObject.h.

Constructor & Destructor Documentation

◆ LightObject()

itk::LightObject::LightObject ( )

protected

Referenced by GetNameOfClass().

◆ ~LightObject()

virtual itk::LightObject::~LightObject ( )

protectedvirtual

Member Function Documentation

◆ BreakOnError()

static void itk::LightObject::BreakOnError ( )

static

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

◆ Clone()

Pointer itk::LightObject::Clone ( ) const

inline

Creates and returns a clone of this object.

Definition at line 79 of file itkLightObject.h.

References InternalClone().

◆ CreateAnother()

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.

◆ Delete()

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.

◆ GetNameOfClass()

virtual const char * itk::LightObject::GetNameOfClass ( ) const

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.

References LightObject().

◆ GetReferenceCount()

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtual

Gets the reference count on this object.

Definition at line 130 of file itkLightObject.h.

References GetReferenceCount(), and m_ReferenceCount.

Referenced by GetReferenceCount().

◆ InternalClone()

virtual LightObject::Pointer itk::LightObject::InternalClone ( ) const

protectedvirtual

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

Referenced by Clone().

◆ New()

static Pointer itk::LightObject::New ( )

static

Method for creation through the object factory.

◆ Print()

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

Cause the object to print itself out.

Referenced by itk::VideoStream< InputFrameType >::PrintSelf().

◆ PrintHeader()

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

protectedvirtual

◆ PrintSelf()

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

protectedvirtual

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.

◆ PrintTrailer()

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

protectedvirtual

◆ Register()

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

virtual

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

Reimplemented in itk::Object.

◆ SetReferenceCount()

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.

◆ UnRegister()

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

virtualnoexcept

Decrease the reference count (release by another object).

Reimplemented in itk::Object.

Member Data Documentation

◆ m_ReferenceCount

std::atomic<int> itk::LightObject::m_ReferenceCount {}

mutableprotected

Number of uses of this object by other objects.

Definition at line 165 of file itkLightObject.h.

Referenced by GetReferenceCount().

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

itkLightObject.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

Constructor & Destructor Documentation

◆ LightObject()

◆ ~LightObject()

Member Function Documentation

◆ BreakOnError()

◆ Clone()

◆ CreateAnother()

◆ Delete()

◆ GetNameOfClass()

◆ GetReferenceCount()

◆ InternalClone()

◆ New()

◆ Print()

◆ PrintHeader()

◆ PrintSelf()

◆ PrintTrailer()

◆ Register()

◆ SetReferenceCount()

◆ UnRegister()

Member Data Documentation

◆ m_ReferenceCount