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 SmartPointer< const Self > ConstPointer

typedef SmartPointer< Self > Pointer

typedef XMLWriterBase Self

typedef Object Superclass

Public Member Functions

virtual void AbortGenerateDataOff ()

virtual void AbortGenerateDataOn ()

virtual int CanWriteFile (const char *name)=0

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

virtual const bool & GetAbortGenerateData ()

Command * GetCommand (unsigned long tag)

bool GetDebug () const

virtual const char * GetFilename () const

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

virtual const char * GetNameOfClass () const

virtual int GetReferenceCount () const

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

virtual void Modified () const

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

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

virtual void SetAbortGenerateData (bool _arg)

void SetDebug (bool debugFlag) const

virtual void SetFilename (const char *_arg)

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

void SetObject (T *toWrite)

virtual void SetReferenceCount (int)

virtual void UnRegister () const

virtual void UpdateOutputData ()

void UpdateProgress (float amount)

void WriteCharacterData (const char *const data, std::ofstream &file)

void WriteEndElement (std::string &tag, std::ofstream &file)

void WriteEndElement (const char *const tag, std::ofstream &file)

virtual int WriteFile ()=0

void WriteStartElement (std::string &tag, std::ofstream &file)

void WriteStartElement (const char *const tag, std::ofstream &file)

XMLWriterBase ()

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

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

virtual const float & GetProgress ()

virtual void SetProgress (float _arg)

Static Public Member Functions

static void BreakOnError ()

static Pointer New ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

virtual void GenerateData ()

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

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

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

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

Protected Attributes

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

std::string m_Filename

T * m_InputObject

void WriteCharacterData (std::string &data, std::ofstream &file)

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 124 of file itkXMLFile.h.

Member Typedef Documentation

typedef SmartPointer<const Self> itk::LightProcessObject::ConstPointer [inherited]

Reimplemented from itk::Object.

Definition at line 78 of file itkLightProcessObject.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

typedef SmartPointer<Self> itk::LightProcessObject::Pointer [inherited]

Reimplemented from itk::Object.

Definition at line 77 of file itkLightProcessObject.h.

template<class T>

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

Standard class typedefs.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::PolygonGroupSpatialObjectXMLFileWriter.

Definition at line 127 of file itkXMLFile.h.

typedef Object itk::LightProcessObject::Superclass [inherited]

Reimplemented from itk::Object.

Definition at line 76 of file itkLightProcessObject.h.

Constructor & Destructor Documentation

template<class T>

itk::XMLWriterBase< T >::XMLWriterBase ( ) [inline]

Constructor Sets object pointer to zero.

Definition at line 132 of file itkXMLFile.h.

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::LightProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

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.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::LightProcessObject::GenerateData ( void ) [inline, protected, virtual, inherited]

This method causes the filter to generate its output.

Reimplemented in itk::ClassifierBase< TDataContainer >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::ClassifierBase< TSample >, itk::ClassifierBase< TInputImage >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, and itk::LevelSetNeighborhoodExtractor< TLevelSet >.

Definition at line 123 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<class T>

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

Get the filename to write

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

virtual const char* itk::LightProcessObject::GetNameOfClass ( ) const [virtual, inherited]

Run-time type information (and related methods).

Reimplemented from itk::Object.

virtual const float& itk::LightProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::LightProcessObject::New ( ) [static, inherited]

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::AnalyzeImageIO, itk::BioRadImageIO, itk::BMPImageIO, itk::Brains2MaskImageIO, itk::DicomImageIO, itk::DICOMImageIO2, itk::GDCMImageIO, itk::GE4ImageIO, itk::GE5ImageIO, itk::GEAdwImageIO, itk::GiplImageIO, itk::IPLCommonImageIO, itk::JPEGImageIO, itk::LSMImageIO, itk::MetaArrayReader, itk::MetaArrayWriter, itk::MetaImageIO, itk::NiftiImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, itk::StimulateImageIO, itk::TIFFImageIO, itk::TransformFileReader, itk::TransformFileWriter, itk::VTKImageIO, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::Bruker2DSEQImageIO, itk::MatlabTransformIO, itk::MINC2ImageIO, itk::PhilipsPAR, itk::PhilipsRECImageIO, itk::TransformFileReader, itk::TransformFileWriter, itk::TxtTransformIO, itk::VoxBoCUBImageIO, itk::LevelSetNeighborhoodExtractor< TLevelSet >, and itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

void itk::LightProcessObject::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

Referenced by itk::Statistics::LearningFunctionBase< LayerType::LayerInterfaceType, TTargetVector >::PrintSelf().

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::LightProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class T>

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

Set the filename to write

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

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 147 of file itkXMLFile.h.

virtual void itk::LightProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::LightProcessObject::UpdateOutputData ( ) [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

template<class T>

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

Write character data inside a tag.

Definition at line 183 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 165 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 177 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 159 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	(	std::string &	tag,
		std::ofstream &	file
	)			`[inline]`

Write a start element tag

Definition at line 171 of file itkXMLFile.h.

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 153 of file itkXMLFile.h.

Member Data Documentation

template<class T>

std::string itk::XMLWriterBase< T >::m_Filename [protected]

Write character data inside a tag.

Definition at line 189 of file itkXMLFile.h.

template<class T>

T* itk::XMLWriterBase< T >::m_InputObject [protected]

Write character data inside a tag.

Definition at line 188 of file itkXMLFile.h.

Referenced by itk::XMLWriterBase< PGroupSpatialObjectType >::SetObject(), and itk::XMLWriterBase< PGroupSpatialObjectType >::XMLWriterBase().

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

itkXMLFile.h


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef XMLWriterBase	Self
typedef Object	Superclass
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual int	CanWriteFile (const char *name)=0
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const char *	GetFilename () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetFilename (const char *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetObject (T *toWrite)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
void	WriteCharacterData (const char *const data, std::ofstream &file)
void	WriteEndElement (std::string &tag, std::ofstream &file)
void	WriteEndElement (const char *const tag, std::ofstream &file)
virtual int	WriteFile ()=0
void	WriteStartElement (std::string &tag, std::ofstream &file)
void	WriteStartElement (const char *const tag, std::ofstream &file)
	XMLWriterBase ()

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

virtual const float &	GetProgress ()

virtual void	SetProgress (float _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	GenerateData ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
std::string	m_Filename
T *	m_InputObject
void	WriteCharacterData (std::string &data, std::ofstream &file)

itk::XMLWriterBase< T > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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