vtkFileOutputWindow Class Reference

#include <vtkFileOutputWindow.h>

Inheritance diagram for vtkFileOutputWindow:

Inheritance graph
[legend]
Collaboration diagram for vtkFileOutputWindow:

Collaboration graph
[legend]

List of all members.


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 32 of file vtkFileOutputWindow.h.


Public Types

typedef vtkOutputWindow Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void DisplayText (const char *)
virtual void SetFileName (const char *)
virtual char * GetFileName ()
virtual void SetFlush (int)
virtual int GetFlush ()
virtual void FlushOn ()
virtual void FlushOff ()
virtual void SetAppend (int)
virtual int GetAppend ()
virtual void AppendOn ()
virtual void AppendOff ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkFileOutputWindowSafeDownCast (vtkObject *o)
static vtkFileOutputWindowNew ()

Protected Member Functions

 vtkFileOutputWindow ()
virtual ~vtkFileOutputWindow ()
void Initialize ()

Protected Attributes

char * FileName
ofstream * OStream
int Flush
int Append

Member Typedef Documentation

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

Definition at line 35 of file vtkFileOutputWindow.h.


Constructor & Destructor Documentation

vtkFileOutputWindow::vtkFileOutputWindow (  )  [protected]

virtual vtkFileOutputWindow::~vtkFileOutputWindow (  )  [protected, virtual]


Member Function Documentation

virtual const char* vtkFileOutputWindow::GetClassName (  )  [virtual]

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

static int vtkFileOutputWindow::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

static vtkFileOutputWindow* vtkFileOutputWindow::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

static vtkFileOutputWindow* vtkFileOutputWindow::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.

Reimplemented from vtkOutputWindow.

Reimplemented in vtkXMLFileOutputWindow.

virtual void vtkFileOutputWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Print ObjectFactor to stream.

Reimplemented from vtkOutputWindow.

virtual void vtkFileOutputWindow::DisplayText ( const char *   )  [virtual]

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]

Reimplemented in vtkXMLFileOutputWindow.


Member Data Documentation

char* vtkFileOutputWindow::FileName [protected]

Definition at line 72 of file vtkFileOutputWindow.h.

ofstream* vtkFileOutputWindow::OStream [protected]

Definition at line 73 of file vtkFileOutputWindow.h.

int vtkFileOutputWindow::Flush [protected]

Definition at line 74 of file vtkFileOutputWindow.h.

int vtkFileOutputWindow::Append [protected]

Definition at line 75 of file vtkFileOutputWindow.h.


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

Generated on Sat Dec 27 13:25:15 2008 for VTK by  doxygen 1.5.6