itk::XMLFileOutputWindow Class Reference

#include <itkXMLFileOutputWindow.h>

Inheritance diagram for itk::XMLFileOutputWindow:

Collaboration diagram for itk::XMLFileOutputWindow:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef XMLFileOutputWindow	Self
typedef FileOutputWindow	Superclass
Public Types inherited from itk::FileOutputWindow
Public Types inherited from itk::OutputWindow
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
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 *)
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 ()
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 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

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
virtual void	DisplayXML (const char *, const char *)
void	Initialize ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	XMLFileOutputWindow ()
virtual	~XMLFileOutputWindow ()
	FileOutputWindow ()
virtual	~FileOutputWindow ()
	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 Attributes inherited from itk::FileOutputWindow
bool	m_Append
std::string	m_FileName
bool	m_Flush
std::ofstream *	m_Stream

---

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.

---

Member Typedef Documentation

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

Reimplemented from itk::FileOutputWindow.

Definition at line 56 of file itkXMLFileOutputWindow.h.

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

Reimplemented from itk::FileOutputWindow.

Definition at line 55 of file itkXMLFileOutputWindow.h.

typedef XMLFileOutputWindow itk::XMLFileOutputWindow::Self

Standard class typedefs.

Reimplemented from itk::FileOutputWindow.

Definition at line 53 of file itkXMLFileOutputWindow.h.

typedef FileOutputWindow itk::XMLFileOutputWindow::Superclass

Reimplemented from itk::FileOutputWindow.

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

Reimplemented from itk::FileOutputWindow.

static Pointer itk::XMLFileOutputWindow::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::FileOutputWindow.

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

private

Reimplemented from itk::FileOutputWindow.

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

protectedvirtual

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.

Reimplemented from itk::FileOutputWindow.

---

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

• itkXMLFileOutputWindow.h