progress handler. More...
#include <vtkPVProgressHandler.h>
Detailed Description
progress handler.
vtkPVProgressHandler handles the progress messages. It handles progress in all configurations single process, client-server, mpi-batch. One progress handler is created per Session.
Progress events are currently not supported in multi-clients mode.
- Events:
- vtkCommand::StartEvent
- fired to indicate beginning of progress handling
calldata:vtkPVProgressHandler* vtkCommand::ProgressEvent- fired to indicate a progress event.
calldata:vtkPVProgressHandler* vtkCommand::EndEvent- fired to indicate end of progress handling
calldata:vtkPVProgressHandler*
- See also:
- vtkPVMPICommunicator
Definition at line 47 of file vtkPVProgressHandler.h.
Member Enumeration Documentation
enum vtkPVProgressHandler::eTAGS [protected] |
Definition at line 95 of file vtkPVProgressHandler.h.
Constructor & Destructor Documentation
| vtkPVProgressHandler::vtkPVProgressHandler | ( | ) | [protected] |
These methods are used by vtkPVMPICommunicator to handle the progress messages received from satellites while waiting on some receive.
| vtkPVProgressHandler::~vtkPVProgressHandler | ( | ) | [protected] |
These methods are used by vtkPVMPICommunicator to handle the progress messages received from satellites while waiting on some receive.
Member Function Documentation
| static vtkPVProgressHandler* vtkPVProgressHandler::New | ( | ) | [static] |
Reimplemented from vtkObject.
| virtual const char* vtkPVProgressHandler::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static int vtkPVProgressHandler::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkObject.
| static vtkPVProgressHandler* vtkPVProgressHandler::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
| void vtkPVProgressHandler::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkObject.
| void vtkPVProgressHandler::SetSession | ( | vtkPVSession * | conn | ) |
Get/Set the session. This is not reference-counted to avoid cycles.
| virtual vtkPVSession* vtkPVProgressHandler::GetSession | ( | ) | [virtual] |
Get/Set the session. This is not reference-counted to avoid cycles.
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 void vtkPVProgressHandler::SetProgressFrequency | ( | double | ) | [virtual] |
Get/Set the progress frequency in seconds. Default is 0.5 seconds.
| virtual double vtkPVProgressHandler::GetProgressFrequency | ( | ) | [virtual] |
Get/Set the progress frequency in seconds. Default is 0.5 seconds.
| virtual char* vtkPVProgressHandler::GetLastProgressText | ( | ) | [virtual] |
These are only valid in handler for the vtkCommand::ProgressEvent.
| virtual int vtkPVProgressHandler::GetLastProgress | ( | ) | [virtual] |
These are only valid in handler for the vtkCommand::ProgressEvent.
| vtkMPICommunicatorOpaqueRequest* vtkPVProgressHandler::GetAsyncRequest | ( | ) |
These methods are used by vtkPVMPICommunicator to handle the progress messages received from satellites while waiting on some receive.
| void vtkPVProgressHandler::RefreshProgress | ( | ) |
These methods are used by vtkPVMPICommunicator to handle the progress messages received from satellites while waiting on some receive.
| void vtkPVProgressHandler::MarkAsyncRequestReceived | ( | ) |
These methods are used by vtkPVMPICommunicator to handle the progress messages received from satellites while waiting on some receive.
| void vtkPVProgressHandler::HandleServerProgress | ( | int | progress, |
| const char * | text | ||
| ) | [protected] |
Called when the client connection (vtkClientConnection) receives progress from the server.
| void vtkPVProgressHandler::CleanupSatellites | ( | ) | [protected] |
Called on MPI processes to pass around the CLEANUP_TAG marking the end of the progress messages.
| bool vtkPVProgressHandler::GetIsRoot | ( | ) | [protected] |
Returns if current process is the root node.
| int vtkPVProgressHandler::GatherProgress | ( | ) | [protected] |
Called on a MPI group to gather progress.
| bool vtkPVProgressHandler::ReportProgress | ( | double | progress | ) | [protected] |
Returns if the progress should be reported.
| void vtkPVProgressHandler::SetLocalProgress | ( | int | progress, |
| const char * | text | ||
| ) | [protected] |
| void vtkPVProgressHandler::SendProgressToClient | ( | vtkMultiProcessController * | ) | [protected] |
| void vtkPVProgressHandler::SendProgressToRoot | ( | ) | [protected] |
| int vtkPVProgressHandler::ReceiveProgressFromSatellites | ( | ) | [protected] |
| void vtkPVProgressHandler::ReceiveProgressFromServer | ( | vtkMultiProcessController * | ) | [protected] |
| virtual void vtkPVProgressHandler::SetLastProgressText | ( | const char * | ) | [protected, virtual] |
Friends And Related Function Documentation
friend class vtkObserver [friend] |
Definition at line 145 of file vtkPVProgressHandler.h.
Member Data Documentation
int vtkPVProgressHandler::LastProgress [protected] |
Definition at line 124 of file vtkPVProgressHandler.h.
char* vtkPVProgressHandler::LastProgressText [protected] |
Definition at line 126 of file vtkPVProgressHandler.h.
double vtkPVProgressHandler::ProgressFrequency [protected] |
Definition at line 127 of file vtkPVProgressHandler.h.
vtkPVSession* vtkPVProgressHandler::Session [protected] |
Definition at line 128 of file vtkPVProgressHandler.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ClientServerCore/vtkPVProgressHandler.h
