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

File Specific output window class. More...

#include <vtkFileOutputWindow.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkFileOutputWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void DisplayText (const char *) override
 Put the text into the log file. More...
 
virtual void SetFileName (const char *)
 Sets the name for the log file. More...
 
virtual char * GetFileName ()
 Sets the name for the log file. More...
 
virtual void SetFlush (int)
 Turns on buffer flushing for the output to the log file. More...
 
virtual int GetFlush ()
 Turns on buffer flushing for the output to the log file. More...
 
virtual void FlushOn ()
 Turns on buffer flushing for the output to the log file. More...
 
virtual void FlushOff ()
 Turns on buffer flushing for the output to the log file. More...
 
virtual void SetAppend (int)
 Setting append will cause the log file to be opened in append mode. More...
 
virtual int GetAppend ()
 Setting append will cause the log file to be opened in append mode. More...
 
virtual void AppendOn ()
 Setting append will cause the log file to be opened in append mode. More...
 
virtual void AppendOff ()
 Setting append will cause the log file to be opened in append mode. More...
 
- Public Member Functions inherited from vtkOutputWindow
vtkOutputWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print ObjectFactor to stream. More...
 
virtual void DisplayDebugText (const char *)
 
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 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 (int)
 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...
 
- 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 int IsTypeOf (const char *type)
 
static vtkFileOutputWindowSafeDownCast (vtkObjectBase *o)
 
static vtkFileOutputWindowNew ()
 
- Static Public Member Functions inherited from vtkOutputWindow
static int IsTypeOf (const char *type)
 
static vtkOutputWindowSafeDownCast (vtkObjectBase *o)
 
static vtkOutputWindowNew ()
 This is a singleton pattern New. 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 ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFileOutputWindow ()
 
 ~vtkFileOutputWindow () override
 
void Initialize ()
 
- Protected Member Functions inherited from vtkOutputWindow
 vtkOutputWindow ()
 
 ~vtkOutputWindow () override
 
- 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

char * FileName
 
ofstream * OStream
 
int Flush
 
int Append
 
- Protected Attributes inherited from vtkOutputWindow
int PromptUser
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

File Specific output window class.

Writes debug/warning/error output to a log file instead of the console. To use this class, instantiate it and then call SetInstance(this).

Tests:
vtkFileOutputWindow (Tests)

Definition at line 34 of file vtkFileOutputWindow.h.

Member Typedef Documentation

Definition at line 37 of file vtkFileOutputWindow.h.

Constructor & Destructor Documentation

vtkFileOutputWindow::vtkFileOutputWindow ( )
protected
vtkFileOutputWindow::~vtkFileOutputWindow ( )
overrideprotected

Member Function Documentation

static int vtkFileOutputWindow::IsTypeOf ( const char *  type)
static
virtual int vtkFileOutputWindow::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 vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

static vtkFileOutputWindow* vtkFileOutputWindow::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkFileOutputWindow::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

vtkFileOutputWindow* vtkFileOutputWindow::NewInstance ( ) const
static vtkFileOutputWindow* vtkFileOutputWindow::New ( )
static
void vtkFileOutputWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObjectBase.

void vtkFileOutputWindow::DisplayText ( const char *  )
overridevirtual

Put the text into the log file.

New lines are converted to carriage return new lines.

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

virtual void vtkFileOutputWindow::SetFileName ( const char *  )
virtual

Sets the name for the log file.

virtual char* vtkFileOutputWindow::GetFileName ( )
virtual

Sets the name for the log file.

virtual void vtkFileOutputWindow::SetFlush ( int  )
virtual

Turns on buffer flushing for the output to the log file.

virtual int vtkFileOutputWindow::GetFlush ( )
virtual

Turns on buffer flushing for the output to the log file.

virtual void vtkFileOutputWindow::FlushOn ( )
virtual

Turns on buffer flushing for the output to the log file.

virtual void vtkFileOutputWindow::FlushOff ( )
virtual

Turns on buffer flushing for the output to the log file.

virtual void vtkFileOutputWindow::SetAppend ( int  )
virtual

Setting append will cause the log file to be opened in append mode.

Otherwise, if the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.

virtual int vtkFileOutputWindow::GetAppend ( )
virtual

Setting append will cause the log file to be opened in append mode.

Otherwise, if the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.

virtual void vtkFileOutputWindow::AppendOn ( )
virtual

Setting append will cause the log file to be opened in append mode.

Otherwise, if the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.

virtual void vtkFileOutputWindow::AppendOff ( )
virtual

Setting append will cause the log file to be opened in append mode.

Otherwise, if the log file exists, it will be overwritten each time the vtkFileOutputWindow is created.

void vtkFileOutputWindow::Initialize ( )
protected

Member Data Documentation

char* vtkFileOutputWindow::FileName
protected

Definition at line 84 of file vtkFileOutputWindow.h.

ofstream* vtkFileOutputWindow::OStream
protected

Definition at line 85 of file vtkFileOutputWindow.h.

int vtkFileOutputWindow::Flush
protected

Definition at line 86 of file vtkFileOutputWindow.h.

int vtkFileOutputWindow::Append
protected

Definition at line 87 of file vtkFileOutputWindow.h.


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