ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::AutoPointerDataObjectDecorator< T > Class Template Reference
System Objects » ITK System ObjectsGroup Core » | Module ITKCommon

#include <itkAutoPointerDataObjectDecorator.h>

Detailed Description

template<typename T>
class itk::AutoPointerDataObjectDecorator< T >

Decorates any pointer to a simple object with a DataObject API using AutoPointer semantics.

AutoPointerDataObjectDecorator decorates a pointer to an object with a DataObject API. This allows a pointer to an object to be encapsulated in a DataObject and passed through the pipeline. This object differs from SimpleDataObjectDecorator in that the decorator takes control of deleting the pointer upon destruction.

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 (i.e. a null pointer).

See also
SimpleDataObjectDecorator
DataObjectDecorator

Definition at line 61 of file itkAutoPointerDataObjectDecorator.h.

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

Public Types

using ComponentPointer = std::unique_ptr< T >
 
using ComponentType = T
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = AutoPointerDataObjectDecorator
 
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 (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
 
const char * GetNameOfClass () const override
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< 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 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 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 *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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

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

ComponentPointer m_Component {}
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ComponentPointer

template<typename T >
using itk::AutoPointerDataObjectDecorator< T >::ComponentPointer = std::unique_ptr<T>

Definition at line 74 of file itkAutoPointerDataObjectDecorator.h.

◆ ComponentType

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

Typedef for the component type (object being decorated)

Definition at line 73 of file itkAutoPointerDataObjectDecorator.h.

◆ ConstPointer

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

Definition at line 70 of file itkAutoPointerDataObjectDecorator.h.

◆ Pointer

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

Definition at line 69 of file itkAutoPointerDataObjectDecorator.h.

◆ Self

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

Standard type alias

Definition at line 67 of file itkAutoPointerDataObjectDecorator.h.

◆ Superclass

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

Definition at line 68 of file itkAutoPointerDataObjectDecorator.h.

Constructor & Destructor Documentation

◆ AutoPointerDataObjectDecorator()

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

◆ ~AutoPointerDataObjectDecorator()

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

Member Function Documentation

◆ Get() [1/2]

template<typename T >
virtual T* itk::AutoPointerDataObjectDecorator< T >::Get ( )
inlinevirtual

Get the contained object

Definition at line 88 of file itkAutoPointerDataObjectDecorator.h.

◆ Get() [2/2]

template<typename T >
virtual const T* itk::AutoPointerDataObjectDecorator< T >::Get ( ) const
inlinevirtual

Get the contained object

Definition at line 93 of file itkAutoPointerDataObjectDecorator.h.

◆ GetNameOfClass()

template<typename T >
const char* itk::AutoPointerDataObjectDecorator< T >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename T >
void itk::AutoPointerDataObjectDecorator< 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::LightObject.

◆ Set()

template<typename T >
virtual void itk::AutoPointerDataObjectDecorator< T >::Set ( T *  val)
virtual

Set the contained object

Member Data Documentation

◆ m_Component

template<typename T >
ComponentPointer itk::AutoPointerDataObjectDecorator< T >::m_Component {}
private

Definition at line 107 of file itkAutoPointerDataObjectDecorator.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16