#include <itkDOMWriter.h>

Inheritance diagram for itk::DOMWriter< TInput >:

Collaboration diagram for itk::DOMWriter< TInput >:

Detailed Description

template<class TInput>
class itk::DOMWriter< TInput >

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:

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();

See Also: XMLWriterBase; DOMNodeXMLWriter; DOMNode

Definition at line 66 of file itkDOMWriter.h.

Public Types
typedef DOMNodeType::Pointer	DOMNodePointer

typedef DOMNode	DOMNodeType

typedef TInput	InputType

typedef LoggerType::Pointer	LoggerPointer

typedef Logger	LoggerType

typedef DOMWriter	Self

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual const char *	GetFileName () const

const InputType *	GetInput () const

virtual LoggerType *	GetLogger () const

virtual const char *	GetNameOfClass () const

virtual void	SetFileName (const char *_arg)

virtual void	SetInput (const InputType *input)

void	Update (DOMNodeType outputdom, const void userdata=0)

virtual void	Update ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual LightObject::Pointer	CreateAnother () const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Protected Member Functions
	DOMWriter ()

virtual void	GenerateData (DOMNodeType outputdom, const void userdata) const =0

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	DOMWriter (const Self &)

void	operator= (const Self &)


virtual void	SetIntermediateDOM (DOMNodeType *_arg)

virtual DOMNodeType *	GetModifiableIntermediateDOM ()

virtual const DOMNodeType *	GetIntermediateDOM () const

Private Attributes
std::string	m_FileName

const InputType *	m_Input

LightObject::ConstPointer	m_InputHolder

DOMNodePointer	m_IntermediateDOM

LoggerPointer	m_Logger

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<class TInput >

typedef DOMNodeType::Pointer itk::DOMWriter< TInput >::DOMNodePointer

Definition at line 78 of file itkDOMWriter.h.

template<class TInput >

typedef DOMNode itk::DOMWriter< TInput >::DOMNodeType

Definition at line 77 of file itkDOMWriter.h.

template<class TInput >

typedef TInput itk::DOMWriter< TInput >::InputType

Definition at line 73 of file itkDOMWriter.h.

template<class TInput >

typedef LoggerType::Pointer itk::DOMWriter< TInput >::LoggerPointer

Definition at line 81 of file itkDOMWriter.h.

template<class TInput >

typedef Logger itk::DOMWriter< TInput >::LoggerType

Definition at line 80 of file itkDOMWriter.h.

template<class TInput >

typedef DOMWriter itk::DOMWriter< TInput >::Self

Standard class typedefs.

Definition at line 71 of file itkDOMWriter.h.

Constructor & Destructor Documentation

template<class TInput >

itk::DOMWriter< TInput >::DOMWriter ( )

protected

template<class TInput >

itk::DOMWriter< TInput >::DOMWriter ( const Self & )

private

Member Function Documentation

template<class TInput >

virtual void itk::DOMWriter< TInput >::GenerateData	(	DOMNodeType *	outputdom,
		const void *	userdata
	)		const

protectedpure virtual

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.

template<class TInput >

virtual const char* itk::DOMWriter< TInput >::GetFileName ( ) const

virtual

Get the output XML filename.

template<class TInput >

const InputType* itk::DOMWriter< TInput >::GetInput ( ) const

Get the input object to be written.

template<class TInput >

virtual const DOMNodeType* itk::DOMWriter< TInput >::GetIntermediateDOM ( ) const

privatevirtual

Get/Set the intermediate DOM object.

template<class TInput >

virtual LoggerType* itk::DOMWriter< TInput >::GetLogger ( ) const

virtual

Return the internal logger so that users can change the output format or add/remove logging destinations.

template<class TInput >

virtual DOMNodeType* itk::DOMWriter< TInput >::GetModifiableIntermediateDOM ( )

privatevirtual

Get/Set the intermediate DOM object.

template<class TInput >

virtual const char* itk::DOMWriter< TInput >::GetNameOfClass ( ) const

virtual

Standard part of all itk objects.

Reimplemented from itk::Object.

template<class TInput >

void itk::DOMWriter< TInput >::operator= ( const Self & )

private

template<class TInput >

virtual void itk::DOMWriter< TInput >::SetFileName ( const char * _arg )

virtual

Set the output XML filename.

template<class TInput >

virtual void itk::DOMWriter< TInput >::SetInput ( const InputType * input )

virtual

Set the input object to be written.

template<class TInput >

virtual void itk::DOMWriter< TInput >::SetIntermediateDOM ( DOMNodeType * _arg )

privatevirtual

Get/Set the intermediate DOM object.

template<class TInput >

void itk::DOMWriter< TInput >::Update	(	DOMNodeType *	outputdom,
		const void *	userdata = `0`
	)

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.

template<class TInput >

virtual void itk::DOMWriter< TInput >::Update ( )

virtual

Function called by end-users to write the input object to the output XML file.

Member Data Documentation

template<class TInput >

std::string itk::DOMWriter< TInput >::m_FileName

private

Variable to hold the output XML file name.

Definition at line 131 of file itkDOMWriter.h.

template<class TInput >

const InputType* itk::DOMWriter< TInput >::m_Input

private

Variable to hold the input object.

Definition at line 138 of file itkDOMWriter.h.

template<class TInput >

LightObject::ConstPointer itk::DOMWriter< TInput >::m_InputHolder

private

Variable to hold the input object if it is a smart object.

Definition at line 141 of file itkDOMWriter.h.

template<class TInput >

DOMNodePointer itk::DOMWriter< TInput >::m_IntermediateDOM

private

Variable to hold the intermediate DOM object.

Definition at line 144 of file itkDOMWriter.h.

template<class TInput >

LoggerPointer itk::DOMWriter< TInput >::m_Logger

mutableprivate

Variable to log various messages during the writing process.

Definition at line 147 of file itkDOMWriter.h.

The documentation for this class was generated from the following file:

itkDOMWriter.h

Detailed Description

template<class TInput> class itk::DOMWriter< TInput >

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInput>
class itk::DOMWriter< TInput >