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

Public Member Functions

virtual int IsA (const char *type)
 
vtkFileOutputWindowNewInstance () const
 
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 ()
 
- Public Member Functions inherited from vtkOutputWindow
vtkOutputWindowNewInstance () const
 
virtual void DisplayDebugText (const char *)
 
virtual void DisplayErrorText (const char *)
 
virtual void DisplayWarningText (const char *)
 
virtual void DisplayGenericWarningText (const char *)
 
virtual void PromptUserOn ()
 
virtual void PromptUserOff ()
 
virtual void SetPromptUser (int)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
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)
 
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 vtkFileOutputWindowSafeDownCast (vtkObjectBase *o)
 
static vtkFileOutputWindowNew ()
 
- Static Public Member Functions inherited from vtkOutputWindow
static int IsTypeOf (const char *type)
 
static vtkOutputWindowSafeDownCast (vtkObjectBase *o)
 
static vtkOutputWindowNew ()
 
static vtkOutputWindowGetInstance ()
 
static void SetInstance (vtkOutputWindow *instance)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *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 ()
 

Protected Member Functions

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

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
 

Additional Inherited Members

- Static Public Attributes inherited from vtkOutputWindow
static vtkOutputWindowCleanup Cleanup
 

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

Member Typedef Documentation

Definition at line 36 of file vtkFileOutputWindow.h.

Constructor & Destructor Documentation

vtkFileOutputWindow::vtkFileOutputWindow ( )
protected
virtual vtkFileOutputWindow::~vtkFileOutputWindow ( )
protectedvirtual

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

Member Data Documentation

char* vtkFileOutputWindow::FileName
protected

Definition at line 73 of file vtkFileOutputWindow.h.

ofstream* vtkFileOutputWindow::OStream
protected

Definition at line 74 of file vtkFileOutputWindow.h.

int vtkFileOutputWindow::Flush
protected

Definition at line 75 of file vtkFileOutputWindow.h.

int vtkFileOutputWindow::Append
protected

Definition at line 76 of file vtkFileOutputWindow.h.


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