itk::DataObjectDecorator< T > Class Template Reference
[ITK System Objects]

Decorates any subclass of itkObject with a DataObject API. More...

#include <itkDataObjectDecorator.h>

Inheritance diagram for itk::DataObjectDecorator< T >:

[legend]Collaboration diagram for itk::DataObjectDecorator< T >:

[legend]List of all members.

Public Types
typedef DataObjectDecorator	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef T	ComponentType
typedef T::Pointer	ComponentPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	Set (T *val)
virtual T *	Get ()
virtual const T *	Get () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	DataObjectDecorator ()
	~DataObjectDecorator ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class T>
class itk::DataObjectDecorator< T >

Decorates any subclass of itkObject with a DataObject API.

DataObjectDecorator decorates an instance of a subclass of itkObject with a DataObject API. This allows any itkObject to be encapsulated into a DataObject that can be passed down the pipeline. To decorate simple types (float, int, std::vector) see SimpleDataObjectDecorator.

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

Note that when an instance of DataObjectDecorator is created, the component is initialized with its default constructor (in this case a null pointer).

DataObjectDecorator can decorate any subclass of itkObject. Two other decorators are provided. SimpleDataObjectDecorator can encapsulate simple types (float, int, std::vector). AutoPointerDataObjectDecorator will decorate any pointer type (for objects other than subclasses of itkObject) and manage the memory deallocationg of the component.

See also:

SimpleDataObjectDecorator

AutoPointerDataObjectDecorator

Definition at line 58 of file itkDataObjectDecorator.h.

---

Member Typedef Documentation

template<class T> typedef T::Pointer itk::DataObjectDecorator< T >::ComponentPointer

Definition at line 69 of file itkDataObjectDecorator.h.

template<class T> typedef T itk::DataObjectDecorator< T >::ComponentType

Typedef for the component type (object being decorated) Definition at line 68 of file itkDataObjectDecorator.h.

template<class T> typedef SmartPointer<const Self> itk::DataObjectDecorator< T >::ConstPointer

Reimplemented from itk::DataObject. Definition at line 65 of file itkDataObjectDecorator.h.

template<class T> typedef SmartPointer<Self> itk::DataObjectDecorator< T >::Pointer

Reimplemented from itk::DataObject. Definition at line 64 of file itkDataObjectDecorator.h.

template<class T> typedef DataObjectDecorator itk::DataObjectDecorator< T >::Self

Standard typedefs. Reimplemented from itk::DataObject. Definition at line 62 of file itkDataObjectDecorator.h.

template<class T> typedef DataObject itk::DataObjectDecorator< T >::Superclass

Reimplemented from itk::DataObject. Definition at line 63 of file itkDataObjectDecorator.h.

---

Constructor & Destructor Documentation

template<class T> itk::DataObjectDecorator< T >::DataObjectDecorator (   )  [protected]

template<class T> itk::DataObjectDecorator< T >::~DataObjectDecorator (   )  [protected]

---

Member Function Documentation

template<class T> virtual const T* itk::DataObjectDecorator< T >::Get (  void   )  const [inline, virtual]

Get the contained object Definition at line 82 of file itkDataObjectDecorator.h.

template<class T> virtual T* itk::DataObjectDecorator< T >::Get (  void   )  [inline, virtual]

Get the contained object Definition at line 81 of file itkDataObjectDecorator.h.

template<class T> virtual const char* itk::DataObjectDecorator< T >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::DataObject.

template<class T> Pointer itk::DataObjectDecorator< T >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class T> virtual void itk::DataObjectDecorator< T >::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. Reimplemented from itk::DataObject.

template<class T> virtual void itk::DataObjectDecorator< T >::Set (  T *  val  )  [virtual]

Set the contained object

---

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

• itkDataObjectDecorator.h

---