ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::DataObjectDecorator< T > Class Template Reference

#include <itkDataObjectDecorator.h>

+ Inheritance diagram for itk::DataObjectDecorator< T >:
+ Collaboration diagram for itk::DataObjectDecorator< T >:

Detailed Description

template<typename 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 66 of file itkDataObjectDecorator.h.

Public Types

typedef T::ConstPointer ComponentConstPointer
 
typedef T::Pointer ComponentPointer
 
typedef T ComponentType
 
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef DataObjectDecorator Self
 
typedef DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual ModifiedTimeType GetMTime () const override
 
virtual const char * GetNameOfClass () const
 
virtual void Graft (const DataObject *) override
 
void Graft (const Self *decorator)
 
virtual void Initialize () override
 
virtual void Set (const ComponentType *val)
 
virtual const ComponentTypeGet () const
 
virtual ComponentTypeGetModifiable ()
 
template<typename TOther >
void Graft (const DataObjectDecorator< TOther > *decorator)
 
- 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 DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
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 ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual const TimeStampGetTimeStamp () 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

 DataObjectDecorator ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~DataObjectDecorator ()
 
- 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

 DataObjectDecorator (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

ComponentPointer m_Component
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename T >
typedef T::ConstPointer itk::DataObjectDecorator< T >::ComponentConstPointer

Definition at line 78 of file itkDataObjectDecorator.h.

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

Definition at line 77 of file itkDataObjectDecorator.h.

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

Typedef for the component type (object being decorated)

Definition at line 76 of file itkDataObjectDecorator.h.

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

Definition at line 73 of file itkDataObjectDecorator.h.

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

Definition at line 72 of file itkDataObjectDecorator.h.

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

Standard typedefs.

Definition at line 70 of file itkDataObjectDecorator.h.

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

Definition at line 71 of file itkDataObjectDecorator.h.

Constructor & Destructor Documentation

template<typename T >
itk::DataObjectDecorator< T >::DataObjectDecorator ( )
protected
template<typename T >
itk::DataObjectDecorator< T >::~DataObjectDecorator ( )
protected
template<typename T >
itk::DataObjectDecorator< T >::DataObjectDecorator ( const Self )
private

Member Function Documentation

template<typename T >
virtual::itk::LightObject::Pointer itk::DataObjectDecorator< 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 const ComponentType* itk::DataObjectDecorator< T >::Get ( ) const
virtual

Get the contained object

template<typename T >
virtual ComponentType* itk::DataObjectDecorator< T >::GetModifiable ( )
virtual

Get the contained object

template<typename T >
virtual ModifiedTimeType itk::DataObjectDecorator< T >::GetMTime ( ) const
overridevirtual

The most recent MTime of this object and the held component

Reimplemented from itk::Object.

template<typename T >
virtual const char* itk::DataObjectDecorator< T >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

template<typename T >
virtual void itk::DataObjectDecorator< T >::Graft ( const DataObject )
overridevirtual

Graft the content of one decorator onto another.

The DataObject is dynamically_cast to this type, if successful then the component pointer is copies to that both decorators refer to the same object.

Reimplemented from itk::DataObject.

template<typename T >
void itk::DataObjectDecorator< T >::Graft ( const Self )
virtual

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Reimplemented from itk::DataObject.

template<typename T >
template<typename TOther >
void itk::DataObjectDecorator< T >::Graft ( const DataObjectDecorator< TOther > *  decorator)
inline

Method to aid in dynamic Graft of polymorphic types.

To this method by default a raw pointer must be used or explicit
template parameter must be provided.

Definition at line 117 of file itkDataObjectDecorator.h.

References itk::DataObjectDecorator< T >::Set().

template<typename T >
virtual void itk::DataObjectDecorator< T >::Initialize ( )
overridevirtual

Restore the data object to its initial state. This means releasing the help component.

Reimplemented from itk::DataObject.

template<typename T >
static Pointer itk::DataObjectDecorator< T >::New ( )
static

Method for creation through the object factory.

template<typename T >
void itk::DataObjectDecorator< T >::operator= ( const Self )
private
template<typename T >
virtual void itk::DataObjectDecorator< 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::DataObjectDecorator< T >::Set ( const ComponentType val)
virtual

Set the contained object

Referenced by itk::DataObjectDecorator< T >::Graft().

Member Data Documentation

template<typename T >
ComponentPointer itk::DataObjectDecorator< T >::m_Component
private

Definition at line 139 of file itkDataObjectDecorator.h.


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