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 Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkOutputWindow *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	DisplayDebugText (const char *)


virtual void	DisplayText (const char *)

virtual void	DisplayErrorText (const char *)

virtual void	DisplayWarningText (const char *)

virtual void	DisplayGenericWarningText (const char *)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

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

static vtkOutputWindow *	SafeDownCast (vtkObjectBase *o)

static vtkOutputWindow *	New ()

static vtkOutputWindow *	GetInstance ()

static void	SetInstance (vtkOutputWindow *instance)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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 &)

static vtkOutputWindowCleanup	Cleanup

int	PromptUser

virtual void	PromptUserOn ()

virtual void	PromptUserOff ()

virtual void	SetPromptUser (int)

	vtkOutputWindow ()

virtual	~vtkOutputWindow ()

Additional Inherited Members
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.

Events:: vtkCommand::ErrorEvent vtkCommand::MessageEvent vtkCommand::WarningEvent

Tests:: vtkOutputWindow (Tests)

Definition at line 49 of file vtkOutputWindow.h.

Member Typedef Documentation

typedef vtkObject vtkOutputWindow::Superclass

Definition at line 53 of file vtkOutputWindow.h.

Constructor & Destructor Documentation

vtkOutputWindow::vtkOutputWindow ( )

protected

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 vtkOutputWindow::~vtkOutputWindow ( )

protectedvirtual

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.

Member Function Documentation

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

static

virtual int 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 vtkObject.

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

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

static

virtual vtkObjectBase* vtkOutputWindow::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

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

vtkOutputWindow* vtkOutputWindow::NewInstance ( ) const

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

virtual

Print ObjectFactor to stream.

Reimplemented from vtkObject.

Reimplemented in vtkAndroidOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.

static vtkOutputWindow* vtkOutputWindow::New ( )

static

This is a singleton pattern New. There will only be ONE reference to a vtkOutputWindow object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits.

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.

Reimplemented in vtkXMLFileOutputWindow, vtkAndroidOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, 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.

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.

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.

Reimplemented in vtkXMLFileOutputWindow, and vtkAndroidOutputWindow.

virtual void vtkOutputWindow::DisplayDebugText ( const char * )

virtual

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.

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.

virtual void vtkOutputWindow::SetPromptUser ( int )

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.

Member Data Documentation

vtkOutputWindowCleanup vtkOutputWindow::Cleanup

static

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.

Definition at line 82 of file vtkOutputWindow.h.

int vtkOutputWindow::PromptUser

protected

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.

Definition at line 92 of file vtkOutputWindow.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkOutputWindow.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation