#include <itkSimpleDataObjectDecorator.h>

Inheritance diagram for itk::SimpleDataObjectDecorator< T >:

Collaboration diagram for itk::SimpleDataObjectDecorator< T >:

Detailed Description

template<typename 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.

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 SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

virtual void	Set (const T &val)


virtual T &	Get ()

virtual const T &	Get () const

Public Member Functions inherited from itk::DataObject
virtual void	CopyInformation (const DataObject *)

virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointerForwardReference < ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

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 (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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 ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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 Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
virtual void	PrintSelf (std::ostream &os, Indent indent) const override

	SimpleDataObjectDecorator ()

	~SimpleDataObjectDecorator ()

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~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 &) ITK_DELETE_FUNCTION

	SimpleDataObjectDecorator (const Self &) ITK_DELETE_FUNCTION

Private Attributes
ComponentType	m_Component

bool	m_Initialized

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename T >

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

Typedef for the component type (object being decorated)

Definition at line 76 of file itkSimpleDataObjectDecorator.h.

template<typename T >

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

Definition at line 73 of file itkSimpleDataObjectDecorator.h.

template<typename T >

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

Definition at line 72 of file itkSimpleDataObjectDecorator.h.

template<typename T >

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

Standard typedefs.

Definition at line 70 of file itkSimpleDataObjectDecorator.h.

template<typename T >

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

Definition at line 71 of file itkSimpleDataObjectDecorator.h.

Constructor & Destructor Documentation

template<typename T >

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

protected

template<typename T >

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

protected

template<typename T >

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

private

Member Function Documentation

template<typename T >

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

Reimplemented from itk::Object.

template<typename T >

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

inlinevirtual

Get the contained object

Definition at line 88 of file itkSimpleDataObjectDecorator.h.

References itk::SimpleDataObjectDecorator< T >::m_Component.

Referenced by itk::Testing::HashImageFilter< TImageType >::GetHash(), itk::MinimumMaximumImageFilter< TInputImage >::GetMaximum(), itk::StatisticsImageFilter< TInputImage >::GetMaximum(), itk::StatisticsImageFilter< TInputImage >::GetMean(), itk::MinimumMaximumImageFilter< TInputImage >::GetMinimum(), itk::StatisticsImageFilter< TInputImage >::GetMinimum(), itk::StatisticsImageFilter< TInputImage >::GetSigma(), itk::StatisticsImageFilter< TInputImage >::GetSum(), and itk::StatisticsImageFilter< TInputImage >::GetVariance().

template<typename T >

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

inlinevirtual

Get the contained object

Definition at line 89 of file itkSimpleDataObjectDecorator.h.

References itk::SimpleDataObjectDecorator< T >::m_Component.

template<typename T >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

template<typename T >

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

static

Method for creation through the object factory.

Referenced by itk::HistogramThresholdCalculator< THistogram, TOutput >::MakeOutput().

template<typename T >

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

private

template<typename T >

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

overrideprotectedvirtual

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.

Reimplemented from itk::DataObject.

template<typename T >

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

virtual

Set the contained object