VTK
9.1.0
|
base class for writing debug output to a console More...
#include <vtkOutputWindow.h>
Public Types | |
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. | |
vtkOutputWindow * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Print ObjectFactor to stream. | |
virtual void | DisplayText (const char *) |
Display the text. | |
virtual void | DisplayErrorText (const char *) |
Display the text. | |
virtual void | DisplayWarningText (const char *) |
Display the text. | |
virtual void | DisplayGenericWarningText (const char *) |
Display the text. | |
virtual void | DisplayDebugText (const char *) |
Display the text. | |
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. | |
void | SetUseStdErrorForAllMessages (bool) |
Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to cerr . | |
bool | GetUseStdErrorForAllMessages () |
Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to cerr . | |
void | UseStdErrorForAllMessagesOn () |
Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to cerr . | |
void | UseStdErrorForAllMessagesOff () |
Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to cerr . | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
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. | |
virtual 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. | |
Static Public Member Functions | |
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 (int 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 int | 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 Types | |
enum | MessageTypes { MESSAGE_TYPE_TEXT , MESSAGE_TYPE_ERROR , MESSAGE_TYPE_WARNING , MESSAGE_TYPE_GENERIC_WARNING , MESSAGE_TYPE_DEBUG } |
enum class | StreamType { Null , StdOutput , StdError } |
Protected Member Functions | |
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 *) |
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 |
enum | DisplayModes { DEFAULT = -1 , NEVER = 0 , ALWAYS = 1 , ALWAYS_STDERR = 2 } |
Flag indicates how the vtkOutputWindow handles displaying of text to stderr / stdout . More... | |
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 . | |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 51 of file vtkOutputWindow.h.
typedef vtkObject vtkOutputWindow::Superclass |
Definition at line 55 of file vtkOutputWindow.h.
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.
Enumerator | |
---|---|
DEFAULT | |
NEVER | |
ALWAYS | |
ALWAYS_STDERR |
Definition at line 152 of file vtkOutputWindow.h.
|
protected |
Enumerator | |
---|---|
MESSAGE_TYPE_TEXT | |
MESSAGE_TYPE_ERROR | |
MESSAGE_TYPE_WARNING | |
MESSAGE_TYPE_GENERIC_WARNING | |
MESSAGE_TYPE_DEBUG |
Definition at line 170 of file vtkOutputWindow.h.
|
strongprotected |
Enumerator | |
---|---|
Null | |
StdOutput | |
StdError |
Definition at line 186 of file vtkOutputWindow.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkAndroidOutputWindow, vtkFileOutputWindow, vtkStringOutputWindow, vtkWin32OutputWindow, vtkWin32ProcessOutputWindow, and vtkXMLFileOutputWindow.
|
static |
|
protectedvirtual |
vtkOutputWindow * vtkOutputWindow::NewInstance | ( | ) | const |
|
overridevirtual |
Print ObjectFactor to stream.
Reimplemented from vtkObject.
Reimplemented in vtkStringOutputWindow, vtkWin32OutputWindow, vtkWin32ProcessOutputWindow, and vtkXMLFileOutputWindow.
|
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.
|
static |
Return the singleton instance with no reference counting.
|
static |
Supply a user defined output window.
Call ->Delete() on the supplied instance after setting it.
|
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 vtkAndroidOutputWindow, vtkFileOutputWindow, vtkStringOutputWindow, vtkWin32OutputWindow, vtkWin32ProcessOutputWindow, and vtkXMLFileOutputWindow.
|
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 vtkAndroidOutputWindow, and vtkXMLFileOutputWindow.
|
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 vtkAndroidOutputWindow, and vtkXMLFileOutputWindow.
|
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 vtkAndroidOutputWindow, and vtkXMLFileOutputWindow.
|
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 vtkAndroidOutputWindow, and vtkXMLFileOutputWindow.
|
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.
|
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.
|
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.
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.
SetDisplayModeToAlwaysStdErr
instead. bool vtkOutputWindow::GetUseStdErrorForAllMessages | ( | ) |
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.
SetDisplayModeToAlwaysStdErr
instead. void vtkOutputWindow::UseStdErrorForAllMessagesOn | ( | ) |
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.
SetDisplayModeToAlwaysStdErr
instead. void vtkOutputWindow::UseStdErrorForAllMessagesOff | ( | ) |
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.
SetDisplayModeToAlwaysStdErr
instead.
|
virtual |
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.
|
virtual |
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.
|
inline |
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.
Definition at line 161 of file vtkOutputWindow.h.
|
inline |
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.
Definition at line 162 of file vtkOutputWindow.h.
|
inline |
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.
Definition at line 163 of file vtkOutputWindow.h.
|
inline |
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.
Definition at line 164 of file vtkOutputWindow.h.
|
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.
|
protectedvirtual |
Returns the standard output stream to post the message of the given type on.
|
friend |
Definition at line 208 of file vtkOutputWindow.h.
|
protected |
Definition at line 199 of file vtkOutputWindow.h.