itkDOMWriter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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.
 *
 *=========================================================================*/
 
#ifndef itkDOMWriter_h
#define itkDOMWriter_h
 
#include "itkDOMNodeXMLWriter.h"
#include "itkObject.h"
#include "itkLogger.h"
 
namespace itk
{

template <typename TInput>
class ITK_TEMPLATE_EXPORT DOMWriter : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(DOMWriter);

  using Self = DOMWriter;
 
  itkOverrideGetNameOfClassMacro(DOMWriter);
 
  using InputType = TInput;
 
  using DOMNodeType = DOMNode;
  using DOMNodePointer = typename DOMNodeType::Pointer;
 
  using LoggerType = Logger;
  using LoggerPointer = typename LoggerType::Pointer;

  itkSetStringMacro(FileName);

  itkGetStringMacro(FileName);

  virtual void
  SetInput(const InputType * input);

  const InputType *
  GetInput() const;

  itkGetConstMacro(Logger, LoggerType *);

  void
  Update(DOMNodeType * outputdom, const void * userdata = nullptr);

  virtual void
  Update();
 
protected:
  DOMWriter();

  virtual void
  GenerateData(DOMNodeType * outputdom, const void * userdata) const = 0;
 
private:
  itkSetObjectMacro(IntermediateDOM, DOMNodeType);
  itkGetModifiableObjectMacro(IntermediateDOM, DOMNodeType);
  std::string m_FileName{};

  const InputType * m_Input{};

  typename LightObject::ConstPointer m_InputHolder{};

  DOMNodePointer m_IntermediateDOM{};

  mutable LoggerPointer m_Logger{};
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkDOMWriter.hxx"
#endif
 
#endif // itkDOMWriter_h