ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::SimpleDataObjectDecorator< T > Class Template Reference

#include <itkSimpleDataObjectDecorator.h>

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 deallocating of the component.

See also
DataObjectDecorator
AutoPointerDataObjectDecorator

Definition at line 66 of file itkSimpleDataObjectDecorator.h.

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

Public Types

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

Public Member Functions

const char * GetNameOfClass () const override
 
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
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void Graft (const DataObject *)
 
virtual void Initialize ()
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
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 ()
 
void UpdateSource () const
 
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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
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 Pointer New ()
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 SimpleDataObjectDecorator ()=default
 
 ~SimpleDataObjectDecorator () override=default
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
 ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 Attributes

ComponentType m_Component {}
 
bool m_Initialized {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ComponentType

template<typename T >
using itk::SimpleDataObjectDecorator< T >::ComponentType = T

Typedef for the component type (object being decorated)

Definition at line 78 of file itkSimpleDataObjectDecorator.h.

◆ ConstPointer

template<typename T >
using itk::SimpleDataObjectDecorator< T >::ConstPointer = SmartPointer<const Self>

Definition at line 75 of file itkSimpleDataObjectDecorator.h.

◆ Pointer

template<typename T >
using itk::SimpleDataObjectDecorator< T >::Pointer = SmartPointer<Self>

Definition at line 74 of file itkSimpleDataObjectDecorator.h.

◆ Self

template<typename T >
using itk::SimpleDataObjectDecorator< T >::Self = SimpleDataObjectDecorator

Standard type alias.

Definition at line 72 of file itkSimpleDataObjectDecorator.h.

◆ Superclass

template<typename T >
using itk::SimpleDataObjectDecorator< T >::Superclass = DataObject

Definition at line 73 of file itkSimpleDataObjectDecorator.h.

Constructor & Destructor Documentation

◆ SimpleDataObjectDecorator()

template<typename T >
itk::SimpleDataObjectDecorator< T >::SimpleDataObjectDecorator ( )
protecteddefault

◆ ~SimpleDataObjectDecorator()

template<typename T >
itk::SimpleDataObjectDecorator< T >::~SimpleDataObjectDecorator ( )
overrideprotecteddefault

Member Function Documentation

◆ Get() [1/2]

template<typename T >
virtual T& itk::SimpleDataObjectDecorator< T >::Get ( )
inlinevirtual

Get the contained object

Definition at line 92 of file itkSimpleDataObjectDecorator.h.

◆ Get() [2/2]

template<typename T >
virtual const T& itk::SimpleDataObjectDecorator< T >::Get ( ) const
inlinevirtual

Get the contained object

Definition at line 97 of file itkSimpleDataObjectDecorator.h.

◆ GetNameOfClass()

template<typename T >
const char* itk::SimpleDataObjectDecorator< T >::GetNameOfClass ( ) const
overridevirtual

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

◆ New()

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

Method for creation through the object factory.

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

◆ PrintSelf()

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

◆ Set()

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

Set the contained object

Member Data Documentation

◆ m_Component

template<typename T >
ComponentType itk::SimpleDataObjectDecorator< T >::m_Component {}
private

Definition at line 111 of file itkSimpleDataObjectDecorator.h.

◆ m_Initialized

template<typename T >
bool itk::SimpleDataObjectDecorator< T >::m_Initialized {}
private

Definition at line 112 of file itkSimpleDataObjectDecorator.h.


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