VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkXMLFileOutputWindow Class Reference

XML File Specific output window class. More...

#include <vtkXMLFileOutputWindow.h>

Inheritance diagram for vtkXMLFileOutputWindow:
[legend]
Collaboration diagram for vtkXMLFileOutputWindow:
[legend]

Public Types

typedef vtkFileOutputWindow Superclass
- Public Types inherited from vtkFileOutputWindow
typedef vtkOutputWindow Superclass
- Public Types inherited from vtkOutputWindow
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void DisplayTag (const char *)
virtual void DisplayText (const char *)
virtual void DisplayErrorText (const char *)
virtual void DisplayWarningText (const char *)
virtual void DisplayGenericWarningText (const char *)
virtual void DisplayDebugText (const char *)
- Public Member Functions inherited from vtkFileOutputWindow
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetFlush (int)
virtual int GetFlush ()
virtual void FlushOn ()
virtual void FlushOff ()
virtual void SetAppend (int)
virtual int GetAppend ()
virtual void AppendOn ()
virtual void AppendOff ()
- Public Member Functions inherited from vtkOutputWindow
virtual void PromptUserOn ()
virtual void PromptUserOff ()
virtual void SetPromptUser (int)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkXMLFileOutputWindowSafeDownCast (vtkObject *o)
static vtkXMLFileOutputWindowNew ()

Protected Member Functions

 vtkXMLFileOutputWindow ()
virtual ~vtkXMLFileOutputWindow ()
void Initialize ()
virtual void DisplayXML (const char *, const char *)
- Protected Member Functions inherited from vtkFileOutputWindow
 vtkFileOutputWindow ()
virtual ~vtkFileOutputWindow ()
- Protected Member Functions inherited from vtkOutputWindow
 vtkOutputWindow ()
virtual ~vtkOutputWindow ()

Additional Inherited Members

- Static Public Attributes inherited from vtkOutputWindow
static vtkOutputWindowCleanup Cleanup
- Protected Attributes inherited from vtkFileOutputWindow
char * FileName
ofstream * OStream
int Flush
int Append
- Friends inherited from vtkObject

Detailed Description

XML File Specific output window class.

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

DisplayText - <Text>

DisplayErrorText - <Error>

DisplayWarningText - <Warning>

DisplayGenericWarningText - <GenericWarning>

DisplayDebugText - <Debug>

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

Tests:
vtkXMLFileOutputWindow (Tests)

Definition at line 45 of file vtkXMLFileOutputWindow.h.

Member Typedef Documentation

Definition at line 48 of file vtkXMLFileOutputWindow.h.

Constructor & Destructor Documentation

vtkXMLFileOutputWindow::vtkXMLFileOutputWindow ( )
inlineprotected

Definition at line 67 of file vtkXMLFileOutputWindow.h.

virtual vtkXMLFileOutputWindow::~vtkXMLFileOutputWindow ( )
inlineprotectedvirtual

Definition at line 68 of file vtkXMLFileOutputWindow.h.

Member Function Documentation

virtual const char* vtkXMLFileOutputWindow::GetClassName ( )
virtual

Reimplemented from vtkFileOutputWindow.

static int vtkXMLFileOutputWindow::IsTypeOf ( const char *  name)
static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkFileOutputWindow.

virtual int vtkXMLFileOutputWindow::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkFileOutputWindow.

static vtkXMLFileOutputWindow* vtkXMLFileOutputWindow::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkFileOutputWindow.

static vtkXMLFileOutputWindow* vtkXMLFileOutputWindow::New ( )
static

This is a singleton pattern New. There will only be ONE reference to a vtkOutputWindow object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits.

Reimplemented from vtkFileOutputWindow.

virtual void vtkXMLFileOutputWindow::DisplayText ( const char *  )
virtual

Put the text into the log file. The text is processed to replace &, <, > with &amp, &lt, and &gt. Each display method outputs a different XML tag.

Reimplemented from vtkFileOutputWindow.

virtual void vtkXMLFileOutputWindow::DisplayErrorText ( const char *  )
virtual

Put the text into the log file. The text is processed to replace &, <, > with &amp, &lt, and &gt. Each display method outputs a different XML tag.

Reimplemented from vtkOutputWindow.

virtual void vtkXMLFileOutputWindow::DisplayWarningText ( const char *  )
virtual

Put the text into the log file. The text is processed to replace &, <, > with &amp, &lt, and &gt. Each display method outputs a different XML tag.

Reimplemented from vtkOutputWindow.

virtual void vtkXMLFileOutputWindow::DisplayGenericWarningText ( const char *  )
virtual

Put the text into the log file. The text is processed to replace &, <, > with &amp, &lt, and &gt. Each display method outputs a different XML tag.

Reimplemented from vtkOutputWindow.

virtual void vtkXMLFileOutputWindow::DisplayDebugText ( const char *  )
virtual

Put the text into the log file. The text is processed to replace &, <, > with &amp, &lt, and &gt. Each display method outputs a different XML tag.

Reimplemented from vtkOutputWindow.

virtual void vtkXMLFileOutputWindow::DisplayTag ( const char *  )
virtual

Put the text into the log file without processing it.

void vtkXMLFileOutputWindow::Initialize ( )
protected

Reimplemented from vtkFileOutputWindow.

virtual void vtkXMLFileOutputWindow::DisplayXML ( const char *  ,
const char *   
)
protectedvirtual

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