ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkPVProgressHandler Class Reference

progress handler. More...

#include <vtkPVProgressHandler.h>

Inherits vtkObject.

Collaboration diagram for vtkPVProgressHandler:
Collaboration graph
[legend]

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 vtkPVSessionGetSession ()
 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 vtkPVProgressHandlerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVProgressHandlerSafeDownCast (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

vtkPVSessionSession
 
double ProgressFrequency
 

Detailed Description

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.

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*

Definition at line 50 of file vtkPVProgressHandler.h.

Member Typedef Documentation

§ Superclass

Definition at line 54 of file vtkPVProgressHandler.h.

Member Enumeration Documentation

§ eTAGS

Enumerator
CLEANUP_TAG 
PROGRESS_EVENT_TAG 
MESSAGE_EVENT_TAG 

Definition at line 109 of file vtkPVProgressHandler.h.

Constructor & Destructor Documentation

§ vtkPVProgressHandler()

vtkPVProgressHandler::vtkPVProgressHandler ( )
protected

§ ~vtkPVProgressHandler()

vtkPVProgressHandler::~vtkPVProgressHandler ( )
protected

Member Function Documentation

§ New()

static vtkPVProgressHandler* vtkPVProgressHandler::New ( )
static

§ GetClassName()

virtual const char* vtkPVProgressHandler::GetClassName ( )
virtual

§ IsTypeOf()

static int vtkPVProgressHandler::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkPVProgressHandler::IsA ( const char *  type)
virtual

§ SafeDownCast()

static vtkPVProgressHandler* vtkPVProgressHandler::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkPVProgressHandler::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ SetSession()

void vtkPVProgressHandler::SetSession ( vtkPVSession conn)

Get/Set the session.

This is not reference-counted to avoid cycles.

§ GetSession()

virtual vtkPVSession* vtkPVProgressHandler::GetSession ( )
virtual

Get/Set the session.

This is not reference-counted to avoid cycles.

§ RegisterProgressEvent()

void vtkPVProgressHandler::RegisterProgressEvent ( vtkObject *  object,
int  id 
)

Listen to progress events from the object.

§ PrepareProgress()

void vtkPVProgressHandler::PrepareProgress ( )

This method resets all the progress counters and prepares progress reporting.

All progress events before this call are ignored.

§ CleanupPendingProgress()

void vtkPVProgressHandler::CleanupPendingProgress ( )

This method collects all outstanding progress messages.

All progress events after this call are ignored.

§ SetProgressFrequency()

virtual void vtkPVProgressHandler::SetProgressFrequency ( double  )
virtual

Get/Set the progress frequency in seconds.

Default is 0.5 seconds.

§ GetProgressFrequency()

virtual double vtkPVProgressHandler::GetProgressFrequency ( )
virtual

Get/Set the progress frequency in seconds.

Default is 0.5 seconds.

§ GetLastProgressText()

virtual char* vtkPVProgressHandler::GetLastProgressText ( )
virtual

These are only valid in handler for the vtkCommand::ProgressEvent.

§ GetLastProgress()

virtual int vtkPVProgressHandler::GetLastProgress ( )
virtual

These are only valid in handler for the vtkCommand::ProgressEvent.

§ GetLastMessage()

virtual char* vtkPVProgressHandler::GetLastMessage ( )
virtual

Temporary storage for most recent message text.

§ RefreshProgress()

void vtkPVProgressHandler::RefreshProgress ( const char *  progress_text,
double  progress 
)
protected

§ RefreshMessage()

void vtkPVProgressHandler::RefreshMessage ( const char *  message_text)
protected

Member Data Documentation

§ Session

vtkPVSession* vtkPVProgressHandler::Session
protected

Definition at line 121 of file vtkPVProgressHandler.h.

§ ProgressFrequency

double vtkPVProgressHandler::ProgressFrequency
protected

Definition at line 122 of file vtkPVProgressHandler.h.


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