VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkOutputWindow Class Reference

base class for writing debug output to a console More...

#include <vtkOutputWindow.h>

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

Public Types

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...
 
vtkOutputWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print ObjectFactor to stream. More...
 
virtual void DisplayText (const char *)
 Display the text. More...
 
virtual void DisplayErrorText (const char *)
 
virtual void DisplayWarningText (const char *)
 
virtual void DisplayGenericWarningText (const char *)
 
virtual void DisplayDebugText (const char *)
 
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 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 Types

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 Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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 &)
 

Protected Attributes

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
 

Friends

class vtkOutputWindowPrivateAccessor
 

Detailed Description

base class for writing debug output to a console

This class is used to encapsulate all text output, so that it will work with operating systems that have a stdout and stderr, and ones that do not. (i.e windows does not). Sub-classes can be provided which can redirect the output to a window.

Definition at line 44 of file vtkOutputWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkOutputWindow.h.

Member Enumeration Documentation

◆ DisplayModes

Flag indicates how the vtkOutputWindow handles displaying of text to stderr / stdout.

Default is DEFAULT except in vtkWin32OutputWindow where on non dashboard runs, the default is NEVER.

NEVER indicates that the messages should never be forwarded to the standard output/error streams.

ALWAYS will result in error/warning/debug messages being posted to the standard error stream, while text messages to standard output stream.

ALWAYS_STDERR will result in all messages being posted to the standard error stream (this was default behavior in VTK 8.1 and earlier).

DEFAULT is similar to ALWAYS except when logging is enabled. If logging is enabled, messages posted to the output window using VTK error/warning macros such as vtkErrorMacro, vtkWarningMacro etc. will not posted on any of the output streams. This is done to avoid duplicate messages on these streams since these macros also result in add items to the log.

Note
vtkStringOutputWindow does not result this flag as is never forwards any text to the output streams.
Enumerator
DEFAULT 
NEVER 
ALWAYS 
ALWAYS_STDERR 

Definition at line 141 of file vtkOutputWindow.h.

◆ MessageTypes

Enumerator
MESSAGE_TYPE_TEXT 
MESSAGE_TYPE_ERROR 
MESSAGE_TYPE_WARNING 
MESSAGE_TYPE_GENERIC_WARNING 
MESSAGE_TYPE_DEBUG 

Definition at line 159 of file vtkOutputWindow.h.

◆ StreamType

enum vtkOutputWindow::StreamType
strongprotected
Enumerator
Null 
StdOutput 
StdError 

Definition at line 175 of file vtkOutputWindow.h.

Constructor & Destructor Documentation

◆ vtkOutputWindow()

vtkOutputWindow::vtkOutputWindow ( )
protected

◆ ~vtkOutputWindow()

vtkOutputWindow::~vtkOutputWindow ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOutputWindow::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 vtkObjectBase.

Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkAndroidOutputWindow, vtkStringOutputWindow, vtkWin32ProcessOutputWindow, and vtkFileOutputWindow.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOutputWindow::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOutputWindow* vtkOutputWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkOutputWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Print ObjectFactor to stream.

Reimplemented from vtkObject.

Reimplemented in vtkWin32OutputWindow, vtkStringOutputWindow, and vtkWin32ProcessOutputWindow.

◆ New()

static vtkOutputWindow* vtkOutputWindow::New ( )
static

Creates a new instance of vtkOutputWindow.

Note this will create a new instance using the vtkObjectFactor. If you want to access the global instance, use GetInstance instead.

◆ GetInstance()

static vtkOutputWindow* vtkOutputWindow::GetInstance ( )
static

Return the singleton instance with no reference counting.

◆ SetInstance()

static void vtkOutputWindow::SetInstance ( vtkOutputWindow instance)
static

Supply a user defined output window.

Call ->Delete() on the supplied instance after setting it.

◆ DisplayText()

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

Display the text.

Four virtual methods exist, depending on the type of message to display. This allows redirection or reformatting of the messages. The default implementation uses DisplayText for all. Consequently, subclasses can simply override DisplayText and use GetCurrentMessageType to determine the type of message that's being reported.

Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkAndroidOutputWindow, vtkStringOutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.

◆ DisplayErrorText()

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

◆ DisplayWarningText()

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

◆ DisplayGenericWarningText()

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

◆ DisplayDebugText()

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

◆ PromptUserOn()

virtual void vtkOutputWindow::PromptUserOn ( )
virtual

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.

Note that PromptUser has not effect of messages displayed by directly calling DisplayText. The prompt is never shown for such messages.

◆ PromptUserOff()

virtual void vtkOutputWindow::PromptUserOff ( )
virtual

◆ SetPromptUser()

virtual void vtkOutputWindow::SetPromptUser ( bool  )
virtual

◆ SetUseStdErrorForAllMessages()

void vtkOutputWindow::SetUseStdErrorForAllMessages ( bool  )

Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to cerr.

Setting this to true restores that incorrect behavior. When false (default), vtkOutputWindow uses cerr for debug, error and warning messages, and cout for text messages.

Deprecated:
use SetDisplayModeToAlwaysStdErr instead.

◆ GetUseStdErrorForAllMessages()

bool vtkOutputWindow::GetUseStdErrorForAllMessages ( )

◆ UseStdErrorForAllMessagesOn()

void vtkOutputWindow::UseStdErrorForAllMessagesOn ( )

◆ UseStdErrorForAllMessagesOff()

void vtkOutputWindow::UseStdErrorForAllMessagesOff ( )

◆ SetDisplayMode()

virtual void vtkOutputWindow::SetDisplayMode ( int  )
virtual

◆ GetDisplayMode()

virtual int vtkOutputWindow::GetDisplayMode ( )
virtual

◆ SetDisplayModeToDefault()

void vtkOutputWindow::SetDisplayModeToDefault ( )
inline

Definition at line 150 of file vtkOutputWindow.h.

◆ SetDisplayModeToNever()

void vtkOutputWindow::SetDisplayModeToNever ( )
inline

Definition at line 151 of file vtkOutputWindow.h.

◆ SetDisplayModeToAlways()

void vtkOutputWindow::SetDisplayModeToAlways ( )
inline

Definition at line 152 of file vtkOutputWindow.h.

◆ SetDisplayModeToAlwaysStdErr()

void vtkOutputWindow::SetDisplayModeToAlwaysStdErr ( )
inline

Definition at line 153 of file vtkOutputWindow.h.

◆ GetCurrentMessageType()

virtual MessageTypes vtkOutputWindow::GetCurrentMessageType ( )
protectedvirtual

Returns the current message type.

Useful in subclasses that simply want to override DisplayText and also know what type of message is being processed.

◆ GetDisplayStream()

virtual StreamType vtkOutputWindow::GetDisplayStream ( MessageTypes  msgType) const
protectedvirtual

Returns the standard output stream to post the message of the given type on.

Friends And Related Function Documentation

◆ vtkOutputWindowPrivateAccessor

friend class vtkOutputWindowPrivateAccessor
friend

Definition at line 197 of file vtkOutputWindow.h.

Member Data Documentation

◆ PromptUser

bool vtkOutputWindow::PromptUser
protected

Definition at line 188 of file vtkOutputWindow.h.


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