#include <itkXMLFileOutputWindow.h>

Inheritance diagram for itk::XMLFileOutputWindow:

Collaboration diagram for itk::XMLFileOutputWindow:

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 49 of file itkXMLFileOutputWindow.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef XMLFileOutputWindow	Self

typedef FileOutputWindow	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef FileOutputWindow	Self

typedef OutputWindow	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef OutputWindow	Self

typedef Object	Superclass

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 ::itk::LightObject::Pointer	CreateAnother (void) const

virtual void	DisplayDebugText (const char *) ITK_OVERRIDE

virtual void	DisplayErrorText (const char *) ITK_OVERRIDE

virtual void	DisplayGenericOutputText (const char *) ITK_OVERRIDE

virtual void	DisplayTag (const char *)

virtual void	DisplayText (const char *) ITK_OVERRIDE

virtual void	DisplayWarningText (const char *) ITK_OVERRIDE

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::FileOutputWindow
virtual const char *	GetFileName () const

virtual void	SetFileName (const char *_arg)

virtual void	SetFlush (bool _arg)

virtual bool	GetFlush () const

virtual void	FlushOn ()

virtual void	FlushOff ()

virtual void	SetAppend (bool _arg)

virtual bool	GetAppend () const

virtual void	AppendOn ()

virtual void	AppendOff ()

Public Member Functions inherited from itk::OutputWindow
virtual void	SetPromptUser (bool _arg)

virtual bool	GetPromptUser () const

virtual void	PromptUserOn ()

virtual void	PromptUserOff ()

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 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 ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::FileOutputWindow
static Pointer	New ()

Static Public Member Functions inherited from itk::OutputWindow
static Pointer	GetInstance ()

static Pointer	New ()

static void	SetInstance (OutputWindow *instance)

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)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
virtual void	DisplayXML (const char , const char )

void	Initialize ()

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

	XMLFileOutputWindow ()

virtual	~XMLFileOutputWindow ()

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

void	Initialize ()

virtual	~FileOutputWindow ()

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

virtual	~OutputWindow ()

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

Private Member Functions
void	operator= (const Self &)

	XMLFileOutputWindow (const Self &)

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::FileOutputWindow
bool	m_Append

std::string	m_FileName

bool	m_Flush

std::ofstream *	m_Stream

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

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

Definition at line 56 of file itkXMLFileOutputWindow.h.

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

Definition at line 55 of file itkXMLFileOutputWindow.h.

typedef XMLFileOutputWindow itk::XMLFileOutputWindow::Self

Standard class typedefs.

Definition at line 53 of file itkXMLFileOutputWindow.h.

typedef FileOutputWindow itk::XMLFileOutputWindow::Superclass

Definition at line 54 of file itkXMLFileOutputWindow.h.

Constructor & Destructor Documentation

itk::XMLFileOutputWindow::XMLFileOutputWindow ( )

protected

virtual itk::XMLFileOutputWindow::~XMLFileOutputWindow ( )

protectedvirtual

itk::XMLFileOutputWindow::XMLFileOutputWindow ( const Self & )

private

Member Function Documentation

virtual::itk::LightObject::Pointer itk::XMLFileOutputWindow::CreateAnother ( void ) const

virtual

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

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 *
	)

protectedvirtual

virtual const char* itk::XMLFileOutputWindow::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::FileOutputWindow.

void itk::XMLFileOutputWindow::Initialize ( )

protected

static Pointer itk::XMLFileOutputWindow::New ( )

static

Method for creation through the object factory.

void itk::XMLFileOutputWindow::operator= ( const Self & )

private

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

protectedvirtual

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.

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

itkXMLFileOutputWindow.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation