#include <itkXMLFileOutputWindow.h>

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.

Inheritance diagram for itk::XMLFileOutputWindow:

Collaboration diagram for itk::XMLFileOutputWindow:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = XMLFileOutputWindow

using	Superclass = FileOutputWindow

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

using	Pointer = SmartPointer< Self >

using	Self = FileOutputWindow

using	Superclass = OutputWindow

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

using	Pointer = SmartPointer< Self >

using	Self = OutputWindow

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
void	DisplayDebugText (const char *) override

void	DisplayErrorText (const char *) override

void	DisplayGenericOutputText (const char *) override

virtual void	DisplayTag (const char *)

void	DisplayText (const char *) override

void	DisplayWarningText (const char *) override

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::FileOutputWindow
void	DisplayText (const char *) override

virtual const char *	GetFileName () const

const char *	GetNameOfClass () const override

virtual void	SetFileName (const char *_arg)

virtual void	SetFlush (bool _arg)

virtual bool	GetFlush () const

virtual void	FlushOn ()

virtual void	SetAppend (bool _arg)

virtual bool	GetAppend () const

virtual void	AppendOn ()

Public Member Functions inherited from itk::OutputWindow
virtual void	DisplayDebugText (const char *t)

virtual void	DisplayErrorText (const char *t)

virtual void	DisplayGenericOutputText (const char *t)

virtual void	DisplayText (const char *)

virtual void	DisplayWarningText (const char *t)

const char *	GetNameOfClass () const override

virtual void	SetPromptUser (bool _arg)

virtual bool	GetPromptUser () const

virtual void	PromptUserOn ()

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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

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

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

	XMLFileOutputWindow ()

	~XMLFileOutputWindow () override

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

void	Initialize ()

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

	~FileOutputWindow () override

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

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

	~OutputWindow () override

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

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

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

virtual	~LightObject ()

Additional Inherited Members
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
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

using itk::XMLFileOutputWindow::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkXMLFileOutputWindow.h.

◆ Pointer

using itk::XMLFileOutputWindow::Pointer = SmartPointer<Self>

Definition at line 57 of file itkXMLFileOutputWindow.h.

◆ Self

using itk::XMLFileOutputWindow::Self = XMLFileOutputWindow

Standard class type aliases.

Definition at line 55 of file itkXMLFileOutputWindow.h.

◆ Superclass

using itk::XMLFileOutputWindow::Superclass = FileOutputWindow

Definition at line 56 of file itkXMLFileOutputWindow.h.

Constructor & Destructor Documentation

◆ XMLFileOutputWindow()

itk::XMLFileOutputWindow::XMLFileOutputWindow ( )

protected

◆ ~XMLFileOutputWindow()

itk::XMLFileOutputWindow::~XMLFileOutputWindow ( )

overrideprotected

Member Function Documentation

◆ DisplayDebugText()

void itk::XMLFileOutputWindow::DisplayDebugText ( const char * )

overridevirtual

Send a debug string to the XML file.

Reimplemented from itk::OutputWindow.

◆ DisplayErrorText()

void itk::XMLFileOutputWindow::DisplayErrorText ( const char * )

overridevirtual

Send an error string to the XML file.

Reimplemented from itk::OutputWindow.

◆ DisplayGenericOutputText()

void itk::XMLFileOutputWindow::DisplayGenericOutputText ( const char * )

overridevirtual

Send a generic output string to the XML file.

Reimplemented from itk::OutputWindow.

◆ DisplayTag()

virtual void itk::XMLFileOutputWindow::DisplayTag ( const char * )

virtual

Put the text into the log file without processing it.

◆ DisplayText()

void itk::XMLFileOutputWindow::DisplayText ( const char * )

overridevirtual

Send a string to the XML file.

Reimplemented from itk::FileOutputWindow.

◆ DisplayWarningText()

void itk::XMLFileOutputWindow::DisplayWarningText ( const char * )

overridevirtual

Send a warning string to the XML file.

Reimplemented from itk::OutputWindow.

◆ DisplayXML()

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

protectedvirtual

◆ GetNameOfClass()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::FileOutputWindow.

◆ Initialize()

void itk::XMLFileOutputWindow::Initialize ( )

protected

◆ New()

static Pointer itk::XMLFileOutputWindow::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

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

overrideprotectedvirtual

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

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ XMLFileOutputWindow()

◆ ~XMLFileOutputWindow()

Member Function Documentation

◆ DisplayDebugText()

◆ DisplayErrorText()

◆ DisplayGenericOutputText()

◆ DisplayTag()

◆ DisplayText()

◆ DisplayWarningText()

◆ DisplayXML()

◆ GetNameOfClass()

◆ Initialize()

◆ New()

◆ PrintSelf()