itk::SimpleDataObjectDecorator< T > Class Template Reference

#include <itkSimpleDataObjectDecorator.h>

Inheritance diagram for itk::SimpleDataObjectDecorator< T >:

Collaboration diagram for itk::SimpleDataObjectDecorator< T >:

List of all members.

Public Types
typedef T	ComponentType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef SimpleDataObjectDecorator	Self
typedef DataObject	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	Set (const T &val)
Static Public Member Functions
static Pointer	New ()
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

---

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

)

[inline, virtual]

Get the contained object

Definition at line 88 of file itkSimpleDataObjectDecorator.h.

template<class T >

virtual const T& itk::SimpleDataObjectDecorator< T >::Get

(

void

)

const [inline, virtual]

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 [protected, virtual]

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