1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
/*=========================================================================
*
* Portions of this file are subject to the VTK Toolkit Version 3 copyright.
*
* Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
*
* For complete copyright, license and disclaimer of warranty information
* please refer to the NOTICE file at the top of the ITK source tree.
*
*=========================================================================*/
#ifndef itkDataObjectDecorator_h
#define itkDataObjectDecorator_h
#include "itkDataObject.h"
#include "itkObjectFactory.h"
namespace itk
{
/** \class DataObjectDecorator
* \brief 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
* deallocating of the component.
*
* \sa SimpleDataObjectDecorator
* \sa AutoPointerDataObjectDecorator
* \ingroup ITKSystemObjects
*
* \ingroup ITKCommon
*/
template <typename T>
class ITK_TEMPLATE_EXPORT DataObjectDecorator : public DataObject
{
public:
ITK_DISALLOW_COPY_AND_MOVE(DataObjectDecorator);
/** Standard type alias. */
using Self = DataObjectDecorator;
using Superclass = DataObject;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Typedef for the component type (object being decorated) */
using ComponentType = T;
using ComponentPointer = typename T::Pointer;
using ComponentConstPointer = typename T::ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(DataObjectDecorator);
/** Set the contained object */
virtual void
Set(const ComponentType * val);
/** Get the contained object */
virtual const ComponentType *
Get() const;
virtual ComponentType *
GetModifiable();
/** The most recent MTime of this object and the held component */
ModifiedTimeType
GetMTime() const override;
/** Restore the data object to its initial state. This means
* releasing the help component.
*/
void
Initialize() override;
/** \brief 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.
*/
void
Graft(const DataObject *) override;
void
Graft(const Self * data);
/** 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.
*/
template <typename TOther>
void
Graft(const DataObjectDecorator<TOther> * decorator)
{
auto * component = const_cast<ComponentType *>(dynamic_cast<const ComponentType *>(decorator->Get()));
if (!component)
{
return;
}
this->Set(component);
}
protected:
DataObjectDecorator() = default;
~DataObjectDecorator() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
protected:
private:
ComponentPointer m_Component{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkDataObjectDecorator.hxx"
#endif
#endif
|
