ITK  5.2.0
Insight Toolkit
itkDOMReader.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 
19 #ifndef itkDOMReader_h
20 #define itkDOMReader_h
21 
22 #include "itkDOMNodeXMLReader.h"
23 #include "itkObject.h"
24 #include "itkLogger.h"
25 
26 namespace itk
27 {
28 
64 template <typename TOutput>
65 class ITK_TEMPLATE_EXPORT DOMReader : public Object
66 {
67 public:
68  ITK_DISALLOW_COPY_AND_MOVE(DOMReader);
70 
72  using Self = DOMReader;
73 
74  itkTypeMacro(DOMReader, Object);
75 
76  using OutputType = TOutput;
77 
80 
81  using LoggerType = Logger;
83 
85  itkSetStringMacro(FileName);
86 
88  itkGetStringMacro(FileName);
89 
94  virtual void
95  SetOutput(OutputType * output);
96 
98  OutputType *
99  GetOutput();
100 
102  const OutputType *
103  GetOutput() const;
104 
109  itkGetConstMacro(Logger, LoggerType *);
110 
116  void
117  Update(const DOMNodeType * inputdom, const void * userdata = nullptr);
118 
122  virtual void
123  Update();
124 
125 protected:
126  DOMReader();
127 
135  virtual void
136  GenerateData(const DOMNodeType * inputdom, const void * userdata) = 0;
137 
138 private:
140  itkSetObjectMacro(IntermediateDOM, DOMNodeType);
141  itkGetModifiableObjectMacro(IntermediateDOM, DOMNodeType);
143 
145  std::string m_FileName;
146 
149 
152 
155 
158 };
159 
160 } // namespace itk
161 
162 #ifndef ITK_MANUAL_INSTANTIATION
163 # include "itkDOMReader.hxx"
164 #endif
165 
166 #endif // itkDOMReader_h
itk::DOMReader::m_OutputHolder
LightObject::Pointer m_OutputHolder
Definition: itkDOMReader.h:151
itk::Logger
Used for logging information during a run.
Definition: itkLogger.h:36
itk::DOMReader
Class to read an ITK object from an XML file or a DOM object, using the DOM APIs.
Definition: itkDOMReader.h:65
itk::DOMReader::OutputType
TOutput OutputType
Definition: itkDOMReader.h:76
itk::SmartPointer< Self >
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkDOMNodeXMLReader.h
itk::DOMReader::LoggerPointer
typename LoggerType::Pointer LoggerPointer
Definition: itkDOMReader.h:82
itk::DOMNode
Class to represent a node in a Document Object Model (DOM) tree structure.
Definition: itkDOMNode.h:53
itk::DOMReader::m_FileName
std::string m_FileName
Definition: itkDOMReader.h:141
itkObject.h
itk::DOMReader::m_Output
OutputType * m_Output
Definition: itkDOMReader.h:148
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62
itk::DOMReader::m_Logger
LoggerPointer m_Logger
Definition: itkDOMReader.h:157
itk::DOMReader::m_IntermediateDOM
DOMNodePointer m_IntermediateDOM
Definition: itkDOMReader.h:154
itk::DOMReader::DOMNodePointer
typename DOMNodeType::Pointer DOMNodePointer
Definition: itkDOMReader.h:79
itkLogger.h