itk::XMLFileOutputWindow Class Reference
[OS System Objects]

#include <itkXMLFileOutputWindow.h>

Inheritance diagram for itk::XMLFileOutputWindow:

[legend]Collaboration diagram for itk::XMLFileOutputWindow:

[legend]List of all members.

---

Detailed Description

Messages sent from the system are sent to a file with each message enclosed by XML tags.

Writes debug/warning/error output to an XML file. Uses predefined XML tags for each text display method. The text is processed to replace XML markup characters.

DisplayText - <Text>

DisplayErrorText - <Error>

DisplayWarningText - <Warning>

DisplayGenericOutputText - <GenericOutput>

DisplayDebugText - <Debug>

The method DisplayTag outputs the text unprocessed. To use this class, instantiate it and then call SetInstance(this).

Definition at line 47 of file itkXMLFileOutputWindow.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef XMLFileOutputWindow	Self
typedef FileOutputWindow	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	DisplayDebugText (const char *)
virtual void	DisplayErrorText (const char *)
virtual void	DisplayGenericOutputText (const char *)
virtual void	DisplayTag (const char *)
virtual void	DisplayText (const char *)
virtual void	DisplayWarningText (const char *)
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)
void	SetDebug (bool debugFlag) const
virtual void	SetFileName (const char *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)
virtual void	AppendOff ()
virtual void	AppendOn ()
virtual bool	GetAppend ()
virtual void	SetAppend (bool _arg)
virtual void	FlushOff ()
virtual void	FlushOn ()
virtual bool	GetFlush ()
virtual void	SetFlush (bool _arg)
virtual bool	GetPromptUser ()
virtual void	PromptUserOff ()
virtual void	PromptUserOn ()
virtual void	SetPromptUser (bool _arg)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	GetInstance ()
static Pointer	New ()
static void	SetInstance (OutputWindow *instance)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
virtual void	DisplayXML (const char *, const char *)
void	Initialize ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	XMLFileOutputWindow ()
virtual	~XMLFileOutputWindow ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
bool	m_Append
std::string	m_FileName
bool	m_Flush
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
std::ofstream *	m_Stream

---

Member Typedef Documentation

typedef SmartPointer<const Self> itk::XMLFileOutputWindow::ConstPointer

Reimplemented from itk::FileOutputWindow.

Definition at line 54 of file itkXMLFileOutputWindow.h.

typedef SmartPointer<Self> itk::XMLFileOutputWindow::Pointer

Reimplemented from itk::FileOutputWindow.

Definition at line 53 of file itkXMLFileOutputWindow.h.

typedef XMLFileOutputWindow itk::XMLFileOutputWindow::Self

Standard class typedefs.

Reimplemented from itk::FileOutputWindow.

Definition at line 51 of file itkXMLFileOutputWindow.h.

typedef FileOutputWindow itk::XMLFileOutputWindow::Superclass

Reimplemented from itk::FileOutputWindow.

Definition at line 52 of file itkXMLFileOutputWindow.h.

---

Constructor & Destructor Documentation

itk::XMLFileOutputWindow::XMLFileOutputWindow

(

)

[protected]

virtual itk::XMLFileOutputWindow::~XMLFileOutputWindow

(

)

[protected, virtual]

---

Member Function Documentation

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

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

virtual void itk::FileOutputWindow::AppendOff

(

)

[virtual, inherited]

virtual void itk::FileOutputWindow::AppendOn

(

)

[virtual, inherited]

static void itk::LightObject::BreakOnError

(

)

[static, inherited]

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

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::XMLFileOutputWindow::DisplayDebugText

(

const char *

)

[virtual]

Send a debug string to the XML file.

Reimplemented from itk::OutputWindow.

virtual void itk::XMLFileOutputWindow::DisplayErrorText

(

const char *

)

[virtual]

Send an error string to the XML file.

Reimplemented from itk::OutputWindow.

virtual void itk::XMLFileOutputWindow::DisplayGenericOutputText

(

const char *

)

[virtual]

Send a generic output string to the XML file.

Reimplemented from itk::OutputWindow.

virtual void itk::XMLFileOutputWindow::DisplayTag

(

const char *

)

[virtual]

Put the text into the log file without processing it.

virtual void itk::XMLFileOutputWindow::DisplayText

(

const char *

)

[virtual]

Send a string to the XML file.

Reimplemented from itk::FileOutputWindow.

virtual void itk::XMLFileOutputWindow::DisplayWarningText

(

const char *

)

[virtual]

Send a warning string to the XML file.

Reimplemented from itk::OutputWindow.

virtual void itk::XMLFileOutputWindow::DisplayXML	(	const char *	,
		const char *
	)			[protected, virtual]

virtual void itk::FileOutputWindow::FlushOff

(

)

[virtual, inherited]

virtual void itk::FileOutputWindow::FlushOn

(

)

[virtual, inherited]

virtual bool itk::FileOutputWindow::GetAppend

(

)

[virtual, inherited]

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.

virtual const char* itk::FileOutputWindow::GetFileName

(

)

const [virtual, inherited]

Get the filename for the log file

virtual bool itk::FileOutputWindow::GetFlush

(

)

[virtual, inherited]

static bool itk::Object::GetGlobalWarningDisplay

(

)

[static, inherited]

static Pointer itk::OutputWindow::GetInstance

(

)

[static, inherited]

Return the singleton instance with no reference counting.

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.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

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

virtual const char* itk::XMLFileOutputWindow::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::FileOutputWindow.

virtual bool itk::OutputWindow::GetPromptUser

(

)

[virtual, inherited]

virtual int itk::LightObject::GetReferenceCount

(

)

const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff

(

)

[inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn

(

)

[inline, static, inherited]

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::XMLFileOutputWindow::Initialize

(

)

[protected]

Reimplemented from itk::FileOutputWindow.

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.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

static Pointer itk::XMLFileOutputWindow::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::FileOutputWindow.

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

Cause the object to print itself out.

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

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

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

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

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::FileOutputWindow.

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

virtual void itk::OutputWindow::PromptUserOff

(

)

[virtual, inherited]

virtual void itk::OutputWindow::PromptUserOn

(

)

[virtual, inherited]

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::FileOutputWindow::SetAppend

(

bool

_arg

)

[virtual, inherited]

Setting append will cause the log file to be opened in append mode. Otherwise, if the log file exists, it will be overwritten each time the FileOutputWindow is created.

void itk::Object::SetDebug

(

bool

debugFlag

)

const [inherited]

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

virtual void itk::FileOutputWindow::SetFileName

(

const char *

_arg

)

[virtual, inherited]

Set the filename for the log file

virtual void itk::FileOutputWindow::SetFlush

(

bool

_arg

)

[virtual, inherited]

Set/Get the buffer flushing mode

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

static void itk::OutputWindow::SetInstance

(

OutputWindow *

instance

)

[static, inherited]

Supply a user defined output window. Call ->Delete() on the supplied instance after setting it.

Referenced by itk::LoggerOutput::OverrideITKWindow().

void itk::Object::SetMetaDataDictionary

(

const MetaDataDictionary &

rhs

)

[inherited]

Returns:

Set the MetaDataDictionary

virtual void itk::OutputWindow::SetPromptUser

(

bool

_arg

)

[virtual, inherited]

If PromptUser is set to true then each time a line of text is displayed, the user is asked if they want to keep getting messages.

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.

---

Member Data Documentation

bool itk::FileOutputWindow::m_Append [protected, inherited]

Definition at line 84 of file itkFileOutputWindow.h.

std::string itk::FileOutputWindow::m_FileName [protected, inherited]

Definition at line 82 of file itkFileOutputWindow.h.

bool itk::FileOutputWindow::m_Flush [protected, inherited]

Definition at line 83 of file itkFileOutputWindow.h.

volatile int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

std::ofstream* itk::FileOutputWindow::m_Stream [protected, inherited]

Definition at line 81 of file itkFileOutputWindow.h.

---

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

• itkXMLFileOutputWindow.h

---