itkDOMNodeXMLReader.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 itkDOMNodeXMLReader_h
#define itkDOMNodeXMLReader_h
 
#include "itkDOMNode.h"
#include "itkObject.h"
#include "ITKIOXMLExport.h"
 
#include <istream>
 
namespace itk
{

class ITKIOXML_EXPORT DOMNodeXMLReader : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(DOMNodeXMLReader);

  using Self = DOMNodeXMLReader;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(DOMNodeXMLReader);
 
  using OutputType = DOMNode;
  using OutputPointer = OutputType::Pointer;

  itkSetStringMacro(FileName);

  itkGetStringMacro(FileName);

  itkSetObjectMacro(DOMNodeXML, OutputType);
#if !defined(ITK_LEGACY_REMOVE)
  // Provide backwards compatible interface
  virtual void
  SetOutput(OutputType * _arg)
  {
    this->SetDOMNodeXML(_arg);
  }
#endif
  // NOTE:  The m_DOMNodeXML is only
  //       exposed via the Source generation interface
  //       by the GetOutput() method that mimics
  //       a process object.
  virtual const OutputType *
  GetOutput() const
  {
    return this->m_DOMNodeXML.GetPointer();
  }
  virtual OutputType *
  GetOutput()
  {
    return this->m_DOMNodeXML.GetPointer();
  }

#if !defined(ITK_LEGACY_REMOVE)
  // This interface was exposed in ITKv4 when the itkGetModifiableObjectMacro was used
  virtual OutputType *
  GetModifiedOutput()
  {
    return this->m_DOMNodeXML.GetPointer();
  }
#endif

  void
  Update(std::istream & is);

  virtual void
  Update();

  virtual void
  StartElement(const char * name, const char ** atts);

  virtual void
  EndElement(const char * name);

  virtual void
  CharacterDataHandler(const char * text, int len);
 
protected:
  DOMNodeXMLReader();
 
private:
  std::string m_FileName{};

  OutputPointer m_DOMNodeXML{};

  OutputType * m_Context{ nullptr };
};
 
} // namespace itk

inline std::istream &
operator>>(std::istream & is, itk::DOMNode & object)
{
  auto reader = itk::DOMNodeXMLReader::New();
  reader->SetDOMNodeXML(&object);
  reader->Update(is);
  return is;
}
#endif // itkDOMNodeXMLReader_h