XML File Specific output window class. More...

#include <vtkXMLFileOutputWindow.h>

Inheritance diagram for vtkXMLFileOutputWindow:

Collaboration diagram for vtkXMLFileOutputWindow:

Public Types
typedef vtkFileOutputWindow	Superclass

Public Types inherited from vtkFileOutputWindow
typedef vtkOutputWindow	Superclass

Public Types inherited from vtkOutputWindow
typedef vtkObject	Superclass

enum	DisplayModes { DEFAULT = -1 , NEVER = 0 , ALWAYS = 1 , ALWAYS_STDERR = 2 }
	Flag indicates how the vtkOutputWindow handles displaying of text to `stderr` / `stdout`. More...

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkXMLFileOutputWindow *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	DisplayTag (const char *)
	Put the text into the log file without processing it.


void	DisplayText (const char *) override
	Put the text into the log file.

void	DisplayErrorText (const char *) override
	Put the text into the log file.

void	DisplayWarningText (const char *) override
	Put the text into the log file.

void	DisplayGenericWarningText (const char *) override
	Put the text into the log file.

void	DisplayDebugText (const char *) override
	Put the text into the log file.

Public Member Functions inherited from vtkFileOutputWindow
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkFileOutputWindow *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	DisplayText (const char *) override
	Put the text into the log file.

	vtkSetFilePathMacro (FileName)
	Sets the name for the log file.

	vtkGetFilePathMacro (FileName)
	Sets the name for the log file.

virtual void	SetFlush (vtkTypeBool)
	Turns on buffer flushing for the output to the log file.

virtual vtkTypeBool	GetFlush ()
	Turns on buffer flushing for the output to the log file.

virtual void	FlushOn ()
	Turns on buffer flushing for the output to the log file.

virtual void	FlushOff ()
	Turns on buffer flushing for the output to the log file.

virtual void	SetAppend (vtkTypeBool)
	Setting append will cause the log file to be opened in append mode.

virtual vtkTypeBool	GetAppend ()
	Setting append will cause the log file to be opened in append mode.

virtual void	AppendOn ()
	Setting append will cause the log file to be opened in append mode.

virtual void	AppendOff ()
	Setting append will cause the log file to be opened in append mode.

Public Member Functions inherited from vtkOutputWindow
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkOutputWindow *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Print ObjectFactor to stream.

virtual void	PromptUserOn ()
	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	PromptUserOff ()
	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	SetPromptUser (bool)
	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	SetDisplayMode (int)
	Flag indicates how the vtkOutputWindow handles displaying of text to `stderr` / `stdout`.

virtual int	GetDisplayMode ()
	Flag indicates how the vtkOutputWindow handles displaying of text to `stderr` / `stdout`.

void	SetDisplayModeToDefault ()
	Flag indicates how the vtkOutputWindow handles displaying of text to `stderr` / `stdout`.

void	SetDisplayModeToNever ()
	Flag indicates how the vtkOutputWindow handles displaying of text to `stderr` / `stdout`.

void	SetDisplayModeToAlways ()
	Flag indicates how the vtkOutputWindow handles displaying of text to `stderr` / `stdout`.

void	SetDisplayModeToAlwaysStdErr ()
	Flag indicates how the vtkOutputWindow handles displaying of text to `stderr` / `stdout`.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkXMLFileOutputWindow *	SafeDownCast (vtkObjectBase *o)

static vtkXMLFileOutputWindow *	New ()

Static Public Member Functions inherited from vtkFileOutputWindow
static vtkTypeBool	IsTypeOf (const char *type)

static vtkFileOutputWindow *	SafeDownCast (vtkObjectBase *o)

static vtkFileOutputWindow *	New ()

Static Public Member Functions inherited from vtkOutputWindow
static vtkTypeBool	IsTypeOf (const char *type)

static vtkOutputWindow *	SafeDownCast (vtkObjectBase *o)

static vtkOutputWindow *	New ()
	Creates a new instance of vtkOutputWindow.

static vtkOutputWindow *	GetInstance ()
	Return the singleton instance with no reference counting.

static void	SetInstance (vtkOutputWindow *instance)
	Supply a user defined output window.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXMLFileOutputWindow ()=default

	~vtkXMLFileOutputWindow () override=default

void	Initialize ()

virtual void	DisplayXML (const char , const char )

Protected Member Functions inherited from vtkFileOutputWindow
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkFileOutputWindow ()

	~vtkFileOutputWindow () override

void	Initialize ()

Protected Member Functions inherited from vtkOutputWindow
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOutputWindow ()

	~vtkOutputWindow () override

virtual MessageTypes	GetCurrentMessageType ()
	Returns the current message type.

virtual StreamType	GetDisplayStream (MessageTypes msgType) const
	Returns the standard output stream to post the message of the given type on.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Types inherited from vtkOutputWindow
enum	MessageTypes { MESSAGE_TYPE_TEXT , MESSAGE_TYPE_ERROR , MESSAGE_TYPE_WARNING , MESSAGE_TYPE_GENERIC_WARNING , MESSAGE_TYPE_DEBUG }

enum class	StreamType { Null , StdOutput , StdError }

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkFileOutputWindow
char *	FileName

ostream *	OStream

vtkTypeBool	Flush

vtkTypeBool	Append

Protected Attributes inherited from vtkOutputWindow
bool	PromptUser

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 35 of file vtkXMLFileOutputWindow.h.

Member Typedef Documentation

◆ Superclass

typedef vtkFileOutputWindow vtkXMLFileOutputWindow::Superclass

Definition at line 38 of file vtkXMLFileOutputWindow.h.

Constructor & Destructor Documentation

◆ vtkXMLFileOutputWindow()

vtkXMLFileOutputWindow::vtkXMLFileOutputWindow ( )

protecteddefault

◆ ~vtkXMLFileOutputWindow()

vtkXMLFileOutputWindow::~vtkXMLFileOutputWindow ( )

overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkXMLFileOutputWindow::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXMLFileOutputWindow::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkFileOutputWindow.

◆ NewInstance()

vtkXMLFileOutputWindow * vtkXMLFileOutputWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkXMLFileOutputWindow::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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 vtkFileOutputWindow.

◆ New()

static vtkXMLFileOutputWindow * vtkXMLFileOutputWindow::New ( )

static