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
enum  DisplayModes { DEFAULT = -1, NEVER = 0, ALWAYS = 1, ALWAYS_STDERR = 2 }
 Flag indicates how the vtkOutputWindow handles displaying of text to stderr / stdout. More...
 
typedef vtkObject Superclass
 

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. More...
 
vtkXMLFileOutputWindowNewInstance () const
 
void DisplayText (const char *) override
 Put the text into the log file. More...
 
void DisplayErrorText (const char *) override
 
void DisplayWarningText (const char *) override
 
void DisplayGenericWarningText (const char *) override
 
void DisplayDebugText (const char *) override
 
virtual void DisplayTag (const char *)
 Put the text into the log file without processing it. More...
 
- Public Member Functions inherited from vtkFileOutputWindow
vtkFileOutputWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFileName (const char *)
 Sets the name for the log file. More...
 
virtual char * GetFileName ()
 
virtual void SetFlush (vtkTypeBool)
 Turns on buffer flushing for the output to the log file. More...
 
virtual vtkTypeBool GetFlush ()
 
virtual void FlushOn ()
 
virtual void FlushOff ()
 
virtual void SetAppend (vtkTypeBool)
 Setting append will cause the log file to be opened in append mode. More...
 
virtual vtkTypeBool GetAppend ()
 
virtual void AppendOn ()
 
virtual void AppendOff ()
 
- Public Member Functions inherited from vtkOutputWindow
vtkOutputWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print ObjectFactor to stream. More...
 
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. More...
 
virtual void PromptUserOff ()
 
virtual void SetPromptUser (bool)
 
void SetUseStdErrorForAllMessages (bool)
 Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to cerr. More...
 
bool GetUseStdErrorForAllMessages ()
 
void UseStdErrorForAllMessagesOn ()
 
void UseStdErrorForAllMessagesOff ()
 
virtual void SetDisplayMode (int)
 
virtual int GetDisplayMode ()
 
void SetDisplayModeToDefault ()
 
void SetDisplayModeToNever ()
 
void SetDisplayModeToAlways ()
 
void SetDisplayModeToAlwaysStdErr ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXMLFileOutputWindowSafeDownCast (vtkObjectBase *o)
 
static vtkXMLFileOutputWindowNew ()
 
- Static Public Member Functions inherited from vtkFileOutputWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFileOutputWindowSafeDownCast (vtkObjectBase *o)
 
static vtkFileOutputWindowNew ()
 
- Static Public Member Functions inherited from vtkOutputWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOutputWindowSafeDownCast (vtkObjectBase *o)
 
static vtkOutputWindowNew ()
 Creates a new instance of vtkOutputWindow. More...
 
static vtkOutputWindowGetInstance ()
 Return the singleton instance with no reference counting. More...
 
static void SetInstance (vtkOutputWindow *instance)
 Supply a user defined output window. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXMLFileOutputWindow ()
 
 ~vtkXMLFileOutputWindow () override
 
void Initialize ()
 
virtual void DisplayXML (const char *, const char *)
 
- Protected Member Functions inherited from vtkFileOutputWindow
 vtkFileOutputWindow ()
 
 ~vtkFileOutputWindow () override
 
void Initialize ()
 
- Protected Member Functions inherited from vtkOutputWindow
 vtkOutputWindow ()
 
 ~vtkOutputWindow () override
 
virtual MessageTypes GetCurrentMessageType ()
 Returns the current message type. More...
 
virtual StreamType GetDisplayStream (MessageTypes msgType) const
 Returns the standard output stream to post the message of the given type on. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 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  StreamType { StreamType::Null, StreamType::StdOutput, StreamType::StdError }
 
- Protected Attributes inherited from vtkFileOutputWindow
char * FileName
 
ofstream * OStream
 
vtkTypeBool Flush
 
vtkTypeBool Append
 
- Protected Attributes inherited from vtkOutputWindow
bool PromptUser
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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).

Definition at line 43 of file vtkXMLFileOutputWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 of file vtkXMLFileOutputWindow.h.

Constructor & Destructor Documentation

◆ vtkXMLFileOutputWindow()

vtkXMLFileOutputWindow::vtkXMLFileOutputWindow ( )
inlineprotected

Definition at line 69 of file vtkXMLFileOutputWindow.h.

◆ ~vtkXMLFileOutputWindow()

vtkXMLFileOutputWindow::~vtkXMLFileOutputWindow ( )
inlineoverrideprotected

Definition at line 70 of file vtkXMLFileOutputWindow.h.

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

◆ New()

static vtkXMLFileOutputWindow* vtkXMLFileOutputWindow::New ( )
static

◆ DisplayText()

void vtkXMLFileOutputWindow::DisplayText ( const char *  )
overridevirtual

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.

◆ DisplayErrorText()

void vtkXMLFileOutputWindow::DisplayErrorText ( const char *  )
overridevirtual

Reimplemented from vtkOutputWindow.

◆ DisplayWarningText()

void vtkXMLFileOutputWindow::DisplayWarningText ( const char *  )
overridevirtual

Reimplemented from vtkOutputWindow.

◆ DisplayGenericWarningText()

void vtkXMLFileOutputWindow::DisplayGenericWarningText ( const char *  )
overridevirtual

Reimplemented from vtkOutputWindow.

◆ DisplayDebugText()

void vtkXMLFileOutputWindow::DisplayDebugText ( const char *  )
overridevirtual

Reimplemented from vtkOutputWindow.

◆ DisplayTag()

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

Put the text into the log file without processing it.

◆ Initialize()

void vtkXMLFileOutputWindow::Initialize ( )
protected

◆ DisplayXML()

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

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