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

#include <vtkOutputWindow.h>

Inheritance diagram for vtkOutputWindow:

Collaboration diagram for vtkOutputWindow:

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

vtkOutputWindow *	NewInstance () 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 *)
	Display the text. More...

virtual void	DisplayWarningText (const char *)
	Display the text. More...

virtual void	DisplayGenericWarningText (const char *)
	Display the text. More...

virtual void	DisplayDebugText (const char *)
	Display the text. 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 ()
	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	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. More...


virtual void	SetUseStdErrorForAllMessages (bool)
	Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to `cerr`. More...

virtual bool	GetUseStdErrorForAllMessages ()
	Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to `cerr`. More...

virtual void	UseStdErrorForAllMessagesOn ()
	Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to `cerr`. More...

virtual void	UseStdErrorForAllMessagesOff ()
	Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to `cerr`. More...

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

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

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

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

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

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

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

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

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

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

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

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

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

static vtkOutputWindow *	SafeDownCast (vtkObjectBase *o)

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

static vtkOutputWindow *	GetInstance ()
	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 vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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

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 vtkObjectBase *	New ()
	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 }

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOutputWindow ()

	~vtkOutputWindow () override

virtual MessageTypes	GetCurrentMessageType ()
	Returns the current message type. 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 ()
	These methods allow a command to exclusively grab all events. More...

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

bool	UseStdErrorForAllMessages

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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.

Tests:: vtkOutputWindow (Tests)

Definition at line 46 of file vtkOutputWindow.h.

Member Typedef Documentation

typedef vtkObject vtkOutputWindow::Superclass

Definition at line 50 of file vtkOutputWindow.h.

Member Enumeration Documentation

enum vtkOutputWindow::MessageTypes

protected

Enumerator
MESSAGE_TYPE_TEXT
MESSAGE_TYPE_ERROR
MESSAGE_TYPE_WARNING
MESSAGE_TYPE_GENERIC_WARNING
MESSAGE_TYPE_DEBUG

Definition at line 119 of file vtkOutputWindow.h.

Constructor & Destructor Documentation

vtkOutputWindow::vtkOutputWindow ( )

protected

vtkOutputWindow::~vtkOutputWindow ( )

overrideprotected

Member Function Documentation

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

static

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, vtkAndroidOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, vtkStringOutputWindow, and vtkWin32ProcessOutputWindow.

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

static

virtual vtkObjectBase* vtkOutputWindow::NewInstanceInternal ( ) const

protectedvirtual

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

vtkOutputWindow* vtkOutputWindow::NewInstance ( ) const

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

overridevirtual

Print ObjectFactor to stream.

Reimplemented from vtkObject.

Reimplemented in vtkWin32OutputWindow, vtkStringOutputWindow, and vtkWin32ProcessOutputWindow.

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.

static vtkOutputWindow* vtkOutputWindow::GetInstance ( )

static

Return the singleton instance with no reference counting.

static void vtkOutputWindow::SetInstance ( vtkOutputWindow * instance )

static

Supply a user defined output window.

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

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, vtkAndroidOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, vtkStringOutputWindow, and vtkWin32ProcessOutputWindow.

virtual void vtkOutputWindow::DisplayErrorText ( 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, and vtkAndroidOutputWindow.

virtual void vtkOutputWindow::DisplayWarningText ( 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, and vtkAndroidOutputWindow.

virtual void vtkOutputWindow::DisplayGenericWarningText ( 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, and vtkAndroidOutputWindow.

virtual void vtkOutputWindow::DisplayDebugText ( 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, and vtkAndroidOutputWindow.

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.

virtual void vtkOutputWindow::PromptUserOff ( )

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 void vtkOutputWindow::SetPromptUser ( bool )

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 void vtkOutputWindow::SetUseStdErrorForAllMessages ( bool )

virtual

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.

virtual bool vtkOutputWindow::GetUseStdErrorForAllMessages ( )

virtual

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.

virtual void vtkOutputWindow::UseStdErrorForAllMessagesOn ( )

virtual

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.

virtual void vtkOutputWindow::UseStdErrorForAllMessagesOff ( )

virtual

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.

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.

Member Data Documentation

bool vtkOutputWindow::PromptUser

protected

Definition at line 133 of file vtkOutputWindow.h.

bool vtkOutputWindow::UseStdErrorForAllMessages

protected

Definition at line 136 of file vtkOutputWindow.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/Core/vtkOutputWindow.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation