ParaView
|
progress handler. More...
#include <vtkPVProgressHandler.h>
Inherits vtkObject.
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
void | RegisterProgressEvent (vtkObject *object, int id) |
Listen to progress events from the object. More... | |
void | PrepareProgress () |
This method resets all the progress counters and prepares progress reporting. More... | |
void | CleanupPendingProgress () |
This method collects all outstanding progress messages. More... | |
void | SetSession (vtkPVSession *conn) |
Get/Set the session. More... | |
virtual vtkPVSession * | GetSession () |
Get/Set the session. More... | |
virtual void | SetProgressFrequency (double) |
Get/Set the progress frequency in seconds. More... | |
virtual double | GetProgressFrequency () |
Get/Set the progress frequency in seconds. More... | |
virtual char * | GetLastProgressText () |
These are only valid in handler for the vtkCommand::ProgressEvent. More... | |
virtual int | GetLastProgress () |
These are only valid in handler for the vtkCommand::ProgressEvent. More... | |
virtual char * | GetLastMessage () |
Temporary storage for most recent message text. More... | |
Static Public Member Functions | |
static vtkPVProgressHandler * | New () |
static int | IsTypeOf (const char *type) |
static vtkPVProgressHandler * | SafeDownCast (vtkObject *o) |
Protected Types | |
enum | eTAGS { CLEANUP_TAG = 188969, PROGRESS_EVENT_TAG = 188970, MESSAGE_EVENT_TAG = 188971 } |
Protected Member Functions | |
vtkPVProgressHandler () | |
~vtkPVProgressHandler () | |
void | RefreshProgress (const char *progress_text, double progress) |
void | RefreshMessage (const char *message_text) |
Protected Attributes | |
vtkPVSession * | Session |
double | ProgressFrequency |
progress handler.
vtkPVProgressHandler handles the progress messages. It handles progress in all configurations single process, client-server. It must be noted that when running in parallel, progress updates are fetched from the root node. Due to performance reasons, we no longer collect progress events (or messages) from satellites, only root-node events are reported back to the client. While this may not faithfully report the progress, this avoid nasty MPI issues that can be painful to debug and diagnose.
Progress events are currently not supported in multi-clients mode.
calldata:
vtkPVProgressHandler* vtkCommand::ProgressEvent calldata:
vtkPVProgressHandler* vtkCommand::EndEvent calldata:
vtkPVProgressHandler* Definition at line 50 of file vtkPVProgressHandler.h.
typedef vtkObject vtkPVProgressHandler::Superclass |
Definition at line 54 of file vtkPVProgressHandler.h.
|
protected |
Enumerator | |
---|---|
CLEANUP_TAG | |
PROGRESS_EVENT_TAG | |
MESSAGE_EVENT_TAG |
Definition at line 109 of file vtkPVProgressHandler.h.
|
protected |
|
protected |
|
static |
|
virtual |
|
static |
|
virtual |
|
static |
void vtkPVProgressHandler::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
void vtkPVProgressHandler::SetSession | ( | vtkPVSession * | conn | ) |
Get/Set the session.
This is not reference-counted to avoid cycles.
|
virtual |
Get/Set the session.
This is not reference-counted to avoid cycles.
void vtkPVProgressHandler::RegisterProgressEvent | ( | vtkObject * | object, |
int | id | ||
) |
Listen to progress events from the object.
void vtkPVProgressHandler::PrepareProgress | ( | ) |
This method resets all the progress counters and prepares progress reporting.
All progress events before this call are ignored.
void vtkPVProgressHandler::CleanupPendingProgress | ( | ) |
This method collects all outstanding progress messages.
All progress events after this call are ignored.
|
virtual |
Get/Set the progress frequency in seconds.
Default is 0.5 seconds.
|
virtual |
Get/Set the progress frequency in seconds.
Default is 0.5 seconds.
|
virtual |
These are only valid in handler for the vtkCommand::ProgressEvent.
|
virtual |
These are only valid in handler for the vtkCommand::ProgressEvent.
|
virtual |
Temporary storage for most recent message text.
|
protected |
|
protected |
|
protected |
Definition at line 121 of file vtkPVProgressHandler.h.
|
protected |
Definition at line 122 of file vtkPVProgressHandler.h.