itk::XMLWriterBase< T > Class Template Reference

#include <itkXMLFile.h>

Inheritance diagram for itk::XMLWriterBase< T >:

Collaboration diagram for itk::XMLWriterBase< T >:

List of all members.

Public Types
typedef XMLWriterBase	Self
Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Superclass
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual int	CanWriteFile (const char *name)=0
virtual const char *	GetFilename () const
virtual void	SetFilename (const char *_arg)
void	SetObject (T *toWrite)
void	WriteCharacterData (const char *const data, std::ofstream &file)
void	WriteCharacterData (std::string &data, std::ofstream &file)
void	WriteEndElement (const char *const tag, std::ofstream &file)
void	WriteEndElement (std::string &tag, std::ofstream &file)
virtual int	WriteFile ()=0
void	WriteStartElement (const char *const tag, std::ofstream &file)
void	WriteStartElement (std::string &tag, std::ofstream &file)
	XMLWriterBase ()
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const bool &	GetAbortGenerateData ()
virtual const char *	GetNameOfClass () const
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) 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 unsigned long	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 Attributes
std::string	m_Filename
T *	m_InputObject

Private Member Functions
void	operator= (const Self &)
	XMLWriterBase (const Self &)

Additional Inherited Members
Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
Protected Member Functions inherited from itk::LightProcessObject
	LightProcessObject ()
void	PrintSelf (std::ostream &os, Indent indent) const
	~LightProcessObject ()
virtual void	GenerateData ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (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 ()

---

Detailed Description

template<class T>
class itk::XMLWriterBase< T >

'Impure virtual' base class for XML File writing. Defines the interface for an XML file writer and provides a few utility functions for writing XML files. A derived class needs to implement writing the file completely by implementing WriteFile.

Definition at line 126 of file itkXMLFile.h.

---

Member Typedef Documentation

template<class T>

typedef XMLWriterBase itk::XMLWriterBase< T >::Self

Standard class typedefs.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::PolygonGroupSpatialObjectXMLFileWriter.

Definition at line 129 of file itkXMLFile.h.

---

Constructor & Destructor Documentation

template<class T>

itk::XMLWriterBase< T >::XMLWriterBase ( )

inline

Constructor Sets object pointer to zero.

Definition at line 134 of file itkXMLFile.h.

template<class T>

itk::XMLWriterBase< T >::XMLWriterBase ( const Self &  )

private

---

Member Function Documentation

template<class T>

virtual int itk::XMLWriterBase< T >::CanWriteFile ( const char *  name )

pure virtual

Return non-zero if the filename given is writeable.

Implemented in itk::PolygonGroupSpatialObjectXMLFileWriter.

template<class T>

virtual const char* itk::XMLWriterBase< T >::GetFilename ( ) const

virtual

Get the filename to write

template<class T>

void itk::XMLWriterBase< T >::operator= ( const Self &  )

private

This method causes the filter to generate its output.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::PolygonGroupSpatialObjectXMLFileWriter.

template<class T>

virtual void itk::XMLWriterBase< T >::SetFilename ( const char *  _arg )

virtual

Set the filename to write

template<class T>

void itk::XMLWriterBase< T >::SetObject ( T *  toWrite )

inline

Give a pointer to the object to be written out to an XML file.

Definition at line 149 of file itkXMLFile.h.

template<class T>

void itk::XMLWriterBase< T >::WriteCharacterData ( const char *const  data, std::ofstream &  file  )

inline

Write character data inside a tag.

Definition at line 167 of file itkXMLFile.h.

template<class T>

void itk::XMLWriterBase< T >::WriteCharacterData ( std::string &  data, std::ofstream &  file  )

inline

Write character data inside a tag.

Definition at line 185 of file itkXMLFile.h.

template<class T>

void itk::XMLWriterBase< T >::WriteEndElement ( const char *const  tag, std::ofstream &  file  )

inline

Write an end element tag

Definition at line 161 of file itkXMLFile.h.

template<class T>

void itk::XMLWriterBase< T >::WriteEndElement ( std::string &  tag, std::ofstream &  file  )

inline

Write an end element tag

Definition at line 179 of file itkXMLFile.h.

template<class T>

virtual int itk::XMLWriterBase< T >::WriteFile ( )

pure virtual

Write the XML file, based on the Input Object

Implemented in itk::PolygonGroupSpatialObjectXMLFileWriter.

template<class T>

void itk::XMLWriterBase< T >::WriteStartElement ( const char *const  tag, std::ofstream &  file  )

inline

Write out a start element tag

Definition at line 155 of file itkXMLFile.h.

template<class T>

void itk::XMLWriterBase< T >::WriteStartElement ( std::string &  tag, std::ofstream &  file  )

inline

Write a start element tag

Definition at line 173 of file itkXMLFile.h.

---

Member Data Documentation

template<class T>

std::string itk::XMLWriterBase< T >::m_Filename

protected

Definition at line 192 of file itkXMLFile.h.

template<class T>

T* itk::XMLWriterBase< T >::m_InputObject

protected

Definition at line 191 of file itkXMLFile.h.

---

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

• itkXMLFile.h