#include <itkSimpleDataObjectDecorator.h>

Inheritance diagram for itk::SimpleDataObjectDecorator< T >:

Collaboration diagram for itk::SimpleDataObjectDecorator< T >:

Public Types
typedef T	ComponentType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef SimpleDataObjectDecorator	Self
typedef DataObject	Superclass
Public Types inherited from itk::DataObject
typedef std::string	DataObjectIdentifierType
typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	Set (const T &val)
Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)
virtual void	DataHasBeenGenerated ()
void	DisconnectPipeline ()
bool	GetDataReleased () const
virtual const bool &	GetReleaseDataFlag ()
SmartPointerForwardReference < ProcessObject >	GetSource () const
DataObjectPointerArraySizeType	GetSourceOutputIndex () const
const DataObjectIdentifierType &	GetSourceOutputName () const
virtual unsigned long	GetUpdateMTime () const
virtual void	Initialize ()
virtual void	PrepareForNewData ()
virtual void	PropagateRequestedRegion ()
void	ReleaseData ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	ResetPipeline ()
void	SetReleaseDataFlag (bool flag)
virtual void	SetRequestedRegion (const DataObject *)
virtual void	SetRequestedRegionToLargestPossibleRegion ()
bool	ShouldIReleaseData () const
virtual void	Update ()
virtual void	UpdateOutputData ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()
void	SetPipelineMTime (unsigned long time)
virtual const unsigned long &	GetPipelineMTime ()
virtual void	SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStamp &	GetRealTimeStamp ()
virtual void	Graft (const DataObject *)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()
static void	GlobalReleaseDataFlagOff ()
static void	GlobalReleaseDataFlagOn ()
static void	SetGlobalReleaseDataFlag (bool val)
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
Protected Member Functions inherited from itk::DataObject
virtual void	PropagateResetPipeline ()
	DataObject ()
	~DataObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)
	SimpleDataObjectDecorator (const Self &)

Private Attributes
ComponentType	m_Component
bool	m_Initialized
virtual T &	Get ()
virtual const T &	Get () const
	SimpleDataObjectDecorator ()
	~SimpleDataObjectDecorator ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const

Additional Inherited Members

Detailed Description

template<class T>
class itk::SimpleDataObjectDecorator< T >

Decorates any "simple" data type (data types without smart pointers) with a DataObject API.

SimpleDataObjectDecorator decorates an object with a DataObject API. This allows simple objects to be encapsulated into objects that can be passed as down the pipeline. This decorator is intended to be used on native types (float, int, etc.) or any objects not derived from itkObject. To decorate a subclass of itkObject, see DataObjectDecorator.

The decorator provides two methods Set() and Get() to access the decorated object (referred internally as the component).

Note that when an instance of SimpleDataObjectDecorator is created, the component is initialized with its default constructor.

SimpleDataObjectDecorator can decorate any simple data type. Two other decorators are provided for decorating pointers. DataObjectDecorator will decorate pointers to subclasses of itkObject (internally storing the pointer in a SmartPointer). AutoPointerDataObjectDecorator will decorate any other pointer and manage the memory deallocationg of the component.

See also:: DataObjectDecorator; AutoPointerDataObjectDecorator

Definition at line 66 of file itkSimpleDataObjectDecorator.h.

Member Typedef Documentation

template<class T >

typedef T itk::SimpleDataObjectDecorator< T >::ComponentType

Typedef for the component type (object being decorated)

Definition at line 76 of file itkSimpleDataObjectDecorator.h.

template<class T >

typedef SmartPointer< const Self > itk::SimpleDataObjectDecorator< T >::ConstPointer

Reimplemented from itk::DataObject.

Definition at line 73 of file itkSimpleDataObjectDecorator.h.

template<class T >

typedef SmartPointer< Self > itk::SimpleDataObjectDecorator< T >::Pointer

Reimplemented from itk::DataObject.

Definition at line 72 of file itkSimpleDataObjectDecorator.h.

template<class T >

typedef SimpleDataObjectDecorator itk::SimpleDataObjectDecorator< T >::Self

Standard typedefs.

Reimplemented from itk::DataObject.

Definition at line 70 of file itkSimpleDataObjectDecorator.h.

template<class T >

typedef DataObject itk::SimpleDataObjectDecorator< T >::Superclass

Reimplemented from itk::DataObject.

Definition at line 71 of file itkSimpleDataObjectDecorator.h.

Constructor & Destructor Documentation

template<class T >

itk::SimpleDataObjectDecorator< T >::SimpleDataObjectDecorator ( )

protected

Get the contained object

template<class T >

itk::SimpleDataObjectDecorator< T >::~SimpleDataObjectDecorator ( )

protected

Get the contained object

template<class T >

itk::SimpleDataObjectDecorator< T >::SimpleDataObjectDecorator ( const Self & )

private

Member Function Documentation

template<class T >

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

template<class T >

virtual T& itk::SimpleDataObjectDecorator< T >::Get ( void )

inlinevirtual

Get the contained object

Definition at line 88 of file itkSimpleDataObjectDecorator.h.

template<class T >

virtual const T& itk::SimpleDataObjectDecorator< T >::Get ( void ) const

inlinevirtual

Get the contained object

Definition at line 89 of file itkSimpleDataObjectDecorator.h.

template<class T >

virtual const char* itk::SimpleDataObjectDecorator< T >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

template<class T >

static Pointer itk::SimpleDataObjectDecorator< T >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class T >

void itk::SimpleDataObjectDecorator< T >::operator= ( const Self & )

private

Reimplemented from itk::DataObject.

template<class T >

virtual void itk::SimpleDataObjectDecorator< T >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

Get the contained object

Reimplemented from itk::DataObject.

template<class T >

virtual void itk::SimpleDataObjectDecorator< T >::Set ( const T & val )

virtual

Set the contained object

Member Data Documentation

template<class T >

ComponentType itk::SimpleDataObjectDecorator< T >::m_Component

private

Definition at line 101 of file itkSimpleDataObjectDecorator.h.

template<class T >

bool itk::SimpleDataObjectDecorator< T >::m_Initialized

private

Definition at line 102 of file itkSimpleDataObjectDecorator.h.

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

itkSimpleDataObjectDecorator.h

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class itk::SimpleDataObjectDecorator< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class itk::SimpleDataObjectDecorator< T >