VTK
Public Types | Public Member Functions | Static Public Member Functions | 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

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void DisplayDebugText (const char *)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
vtkCommandGetCommand (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)
 
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 &os)
 
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 vtkOutputWindowSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
virtual void DisplayText (const char *)
 
virtual void DisplayErrorText (const char *)
 
virtual void DisplayWarningText (const char *)
 
virtual void DisplayGenericWarningText (const char *)
 
static vtkOutputWindowNew ()
 
static vtkOutputWindowGetInstance ()
 
static void SetInstance (vtkOutputWindow *instance)
 
static vtkOutputWindowCleanup Cleanup
 
int PromptUser
 
virtual void PromptUserOn ()
 
virtual void PromptUserOff ()
 
virtual void SetPromptUser (int)
 
 vtkOutputWindow ()
 
virtual ~vtkOutputWindow ()
 

Additional Inherited Members

- 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 &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int 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::WarningEvent vtkCommand::ErrorEvent
Tests:
vtkOutputWindow (Tests)

Definition at line 44 of file vtkOutputWindow.h.

Member Typedef Documentation

Definition at line 48 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

virtual const char* vtkOutputWindow::GetClassName ( )
virtual
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, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.

static vtkOutputWindow* vtkOutputWindow::SafeDownCast ( vtkObject o)
static
virtual void vtkOutputWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Print ObjectFactor to stream.

Reimplemented from vtkObject.

Reimplemented in 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

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 void vtkOutputWindow::SetInstance ( vtkOutputWindow instance)
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.

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

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.

Reimplemented in vtkXMLFileOutputWindow, vtkWin32OutputWindow, vtkFileOutputWindow, and vtkWin32ProcessOutputWindow.

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

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.

Reimplemented in vtkXMLFileOutputWindow.

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

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.

Reimplemented in vtkXMLFileOutputWindow.

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

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.

Reimplemented in vtkXMLFileOutputWindow.

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

Reimplemented in vtkXMLFileOutputWindow.

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 80 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 90 of file vtkOutputWindow.h.


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