/usr/include/ITK-4.5/itkDOMWriter.h is in libinsighttoolkit4-dev 4.5.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 153 | /*=========================================================================
*
* Copyright Insight Software Consortium
*
* 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
*
* http://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
{
/**
* \class DOMWriter
* \brief Class to write an ITK object to an XML file or a DOM object, using the DOM APIs.
*
* End-users need to derive from this class to implement writers for user objects. In subclasses, users need
* to provide an implementation for the virtual function GenerateData(-,-).
*
* This class performs similar functions as the XMLWriterBase - both provide the base for handling object writing to
* an XML destination. The difference is that, writers derived from this class perform object writing using the
* easy-to-use DOM APIs, while XMLWriterBase-based writers directly generate textual XML documents, which is tedious
* and more error prone.
*
* Internally, this class first generates an intermediate DOM object from the input object, then the DOM object
* is implicitly written to the output XML file using the DOMNodeXMLWriter.
*
* Note: Though this class behaves similar to ProcessObject, it is not derived from ProcessObject. This is
* because many user objects to be written, e.g., registrations, transforms, optimizers, and so on, are not objects
* of type DataObject, thus this class cannot be connected to an ITK process pipeline.
*
* The following code snippet demontrates how to use a DOM-based writer that is derived from this class:
*
* \code
* itk::MyObjectType::Pointer input_object = ...
* const char* output_xml_file_name = ...
* itk::MyObjectDOMWriter::Pointer writer = itk::MyObjectDOMWriter::New();
* writer->SetInput( input_object );
* writer->SetFileName( output_xml_file_name );
* writer->Update();
* \endcode
*
* \sa XMLWriterBase
* \sa DOMNodeXMLWriter
* \sa DOMNode
*
* \ingroup ITKIOXML
*/
template< typename TInput >
class DOMWriter : public Object
{
public:
/** Standard class typedefs. */
typedef DOMWriter Self;
itkTypeMacro(DOMWriter, Object);
typedef TInput InputType;
typedef DOMNode DOMNodeType;
typedef typename DOMNodeType::Pointer DOMNodePointer;
typedef Logger LoggerType;
typedef typename LoggerType::Pointer LoggerPointer;
/** Set the output XML filename. */
itkSetStringMacro(FileName);
/** Get the output XML filename. */
itkGetStringMacro(FileName);
/** Set the input object to be written. */
virtual void SetInput( const InputType* input );
/** Get the input object to be written. */
const InputType* GetInput() const;
/**
* Return the internal logger so that users can change the
* output format or add/remove logging destinations.
*/
itkGetConstMacro( Logger, LoggerType* );
/**
* Function called by Update() or end-users to write the input object to a DOM object.
* Some derived writers may accept an incomplete input object during the writing process, in those cases
* the optional argument 'userdata' can be used to provide the missed information.
*/
void Update( DOMNodeType* outputdom, const void* userdata = 0 );
/**
* Function called by end-users to write the input object to the output XML file.
*/
virtual void Update();
protected:
DOMWriter();
/**
* Function to be implemented in subclasses. It is called automatically
* when update functions are performed. It should fill the contents of the intermediate DOM object
* by pulling information from the input object.
* Some derived writers may accept an incomplete input object during the writing process, in those cases
* the optional argument 'userdata' can be used to provide the missed information.
*/
virtual void GenerateData( DOMNodeType* outputdom, const void* userdata ) const = 0;
private:
DOMWriter(const Self &); //purposely not implemented
void operator=(const Self &); //purposely not implemented
/** Get/Set the intermediate DOM object. */
itkSetObjectMacro( IntermediateDOM, DOMNodeType );
itkGetModifiableObjectMacro(IntermediateDOM, DOMNodeType );
/** Variable to hold the output XML file name. */
std::string m_FileName;
/** Variable to hold the input object. */
const InputType* m_Input;
/** Variable to hold the input object if it is a smart object. */
typename LightObject::ConstPointer m_InputHolder;
/** Variable to hold the intermediate DOM object. */
DOMNodePointer m_IntermediateDOM;
/** Variable to log various messages during the writing process. */
mutable LoggerPointer m_Logger;
};
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkDOMWriter.hxx"
#endif
#endif // __itkDOMWriter_h
|