VTK
9.0.1
|
File Specific output window class. More...
#include <vtkFileOutputWindow.h>
Public Types | |
typedef vtkOutputWindow | Superclass |
![]() | |
enum | DisplayModes { DEFAULT = -1 , NEVER = 0 , ALWAYS = 1 , ALWAYS_STDERR = 2 } |
Flag indicates how the vtkOutputWindow handles displaying of text to stderr / stdout . More... | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkFileOutputWindow * | NewInstance () 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 () |
virtual void | SetFlush (vtkTypeBool) |
Turns on buffer flushing for the output to the log file. More... | |
virtual vtkTypeBool | GetFlush () |
virtual void | FlushOn () |
virtual void | FlushOff () |
virtual void | SetAppend (vtkTypeBool) |
Setting append will cause the log file to be opened in append mode. More... | |
virtual vtkTypeBool | GetAppend () |
virtual void | AppendOn () |
virtual void | AppendOff () |
![]() | |
vtkOutputWindow * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Print ObjectFactor to stream. More... | |
virtual void | DisplayErrorText (const char *) |
virtual void | DisplayWarningText (const char *) |
virtual void | DisplayGenericWarningText (const char *) |
virtual void | DisplayDebugText (const char *) |
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 () |
virtual void | SetPromptUser (bool) |
void | SetUseStdErrorForAllMessages (bool) |
Historically (VTK 8.1 and earlier), when printing messages to terminals, vtkOutputWindow would always post messages to cerr . More... | |
bool | GetUseStdErrorForAllMessages () |
void | UseStdErrorForAllMessagesOn () |
void | UseStdErrorForAllMessagesOff () |
virtual void | SetDisplayMode (int) |
virtual int | GetDisplayMode () |
void | SetDisplayModeToDefault () |
void | SetDisplayModeToNever () |
void | SetDisplayModeToAlways () |
void | SetDisplayModeToAlwaysStdErr () |
![]() | |
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... | |
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) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
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) |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
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... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkFileOutputWindow * | SafeDownCast (vtkObjectBase *o) |
static vtkFileOutputWindow * | New () |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkOutputWindow * | SafeDownCast (vtkObjectBase *o) |
static vtkOutputWindow * | New () |
Creates a new instance of vtkOutputWindow. More... | |
static vtkOutputWindow * | GetInstance () |
Return the singleton instance with no reference counting. More... | |
static void | SetInstance (vtkOutputWindow *instance) |
Supply a user defined output window. More... | |
![]() | |
static vtkObject * | New () |
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 () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
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 vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkFileOutputWindow () | |
~vtkFileOutputWindow () override | |
void | Initialize () |
![]() | |
vtkOutputWindow () | |
~vtkOutputWindow () override | |
virtual MessageTypes | GetCurrentMessageType () |
Returns the current message type. More... | |
virtual StreamType | GetDisplayStream (MessageTypes msgType) const |
Returns the standard output stream to post the message of the given type on. More... | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
char * | FileName |
ostream * | OStream |
vtkTypeBool | Flush |
vtkTypeBool | Append |
![]() | |
bool | PromptUser |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
![]() | |
enum | MessageTypes { MESSAGE_TYPE_TEXT , MESSAGE_TYPE_ERROR , MESSAGE_TYPE_WARNING , MESSAGE_TYPE_GENERIC_WARNING , MESSAGE_TYPE_DEBUG } |
enum class | StreamType { Null , StdOutput , StdError } |
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).
Definition at line 30 of file vtkFileOutputWindow.h.
Definition at line 33 of file vtkFileOutputWindow.h.
|
protected |
|
overrideprotected |
|
static |
|
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 |
|
protectedvirtual |
Reimplemented from vtkOutputWindow.
Reimplemented in vtkXMLFileOutputWindow.
vtkFileOutputWindow* vtkFileOutputWindow::NewInstance | ( | ) | const |
|
static |
|
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.
|
overridevirtual |
Put the text into the log file.
New lines are converted to carriage return new lines.
Reimplemented from vtkOutputWindow.
Reimplemented in vtkXMLFileOutputWindow.
|
virtual |
Sets the name for the log file.
|
virtual |
|
virtual |
Turns on buffer flushing for the output to the log file.
|
virtual |
|
virtual |
|
virtual |
|
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 |
|
virtual |
|
virtual |
|
protected |
|
protected |
Definition at line 80 of file vtkFileOutputWindow.h.
|
protected |
Definition at line 81 of file vtkFileOutputWindow.h.
|
protected |
Definition at line 82 of file vtkFileOutputWindow.h.
|
protected |
Definition at line 83 of file vtkFileOutputWindow.h.