vtkPVProgressHandler Class Reference

Object to represent the output of a PVSource. More...

#include <vtkPVProgressHandler.h>

Collaboration diagram for vtkPVProgressHandler:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVProgressHandler, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Cleanup ()
virtual void	PrepareProgress (vtkProcessModule *app)
virtual void	CleanupPendingProgress (vtkProcessModule *app)
virtual void	RegisterProgressEvent (vtkObject *po, int id)
virtual void	SetSocketController (vtkSocketController *soc)
virtual void	SetProcessModule (vtkProcessModule *pvApp)
virtual void	InvokeProgressEvent (vtkProcessModule *pvApp, vtkObject *object, int val, const char *str)
virtual void	SetClientMode (int)
virtual void	SetServerMode (int)
Static Public Member Functions
vtkPVProgressHandler *	New ()
Protected Types
enum	{   NotSet = 0, SingleProcess, SingleProcessMPI, SatelliteMPI,   ClientServerClient, ClientServerServer, ClientServerServerMPI }
Protected Member Functions
	vtkPVProgressHandler ()
	~vtkPVProgressHandler ()
void	DetermineProgressType (vtkProcessModule *app)
void	InvokeSatelliteProgressEvent (vtkProcessModule *, vtkObject *, int val)
void	InvokeRootNodeProgressEvent (vtkProcessModule *, vtkObject *, int val)
void	InvokeRootNodeServerProgressEvent (vtkProcessModule *, vtkObject *, int val)
int	ReceiveProgressFromSatellite (int *id, int *progress)
void	LocalDisplayProgress (vtkProcessModule *app, const char *filter, int progress)
void	HandleProgress (int processid, int filterid, int progress)
	vtkPVProgressHandler (const vtkPVProgressHandler &)
void	operator= (const vtkPVProgressHandler &)
Protected Attributes
vtkProcessModule *	ProcessModule
int	ReceivingProgressReports
int	ProgressPending
int	Progress [4]
int	ProgressType
int	ClientMode
int	ServerMode
int	LocalProcessID
int	NumberOfProcesses
double	MinimumProgressInterval
vtkTimerLog *	ProgressTimer
vtkMPIController *	MPIController
vtkSocketController *	SocketController
vtkPVProgressHandlerInternal *	Internals

---

Detailed Description

Object to represent the output of a PVSource.

This object combines methods for accessing parallel VTK data, and also an interface for changing the view of the data. The interface used to be in a superclass called vtkPVActorComposite. I want to separate the interface from this object, but a superclass is not the way to do it.

Definition at line 37 of file vtkPVProgressHandler.h.

---

Member Enumeration Documentation

anonymous enum [protected]

Types of progress handling. Enumeration values: NotSet  SingleProcess  SingleProcessMPI  SatelliteMPI  ClientServerClient  ClientServerServer  ClientServerServerMPI  Definition at line 100 of file vtkPVProgressHandler.h.

---

Constructor & Destructor Documentation

vtkPVProgressHandler::vtkPVProgressHandler (   )  [protected]

vtkPVProgressHandler::~vtkPVProgressHandler (   )  [protected]

vtkPVProgressHandler::vtkPVProgressHandler (  const vtkPVProgressHandler &   )  [protected]

---

Member Function Documentation

vtkPVProgressHandler* vtkPVProgressHandler::New (   )  [static]

vtkPVProgressHandler::vtkTypeRevisionMacro (  vtkPVProgressHandler  , vtkObject  )

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

virtual void vtkPVProgressHandler::SetProcessModule (  vtkProcessModule *  pvApp  )  [inline, virtual]

Set the process module that will drive progress Definition at line 47 of file vtkPVProgressHandler.h.

virtual void vtkPVProgressHandler::InvokeProgressEvent (  vtkProcessModule *  pvApp, vtkObject *  object, int  val, const char *  str )  [virtual]

Invoke the progress event.

virtual void vtkPVProgressHandler::Cleanup (   )  [inline, virtual]

This method should be called before removing the object. Definition at line 63 of file vtkPVProgressHandler.h.

virtual void vtkPVProgressHandler::PrepareProgress (  vtkProcessModule *  app  )  [virtual]

This method resets all the progress counters and prepares progress reporting. All progress events before this call are ignored.

virtual void vtkPVProgressHandler::CleanupPendingProgress (  vtkProcessModule *  app  )  [virtual]

This method collects all outstanding progress messages. All progress events after this call are ignored.

virtual void vtkPVProgressHandler::RegisterProgressEvent (  vtkObject *  po, int  id )  [virtual]

This method register object to be observed.

virtual void vtkPVProgressHandler::SetSocketController (  vtkSocketController *  soc  )  [virtual]

Set the socket controller.

virtual void vtkPVProgressHandler::SetClientMode (  int   )  [virtual]

Set client and server mode

virtual void vtkPVProgressHandler::SetServerMode (  int   )  [virtual]

Set client and server mode

void vtkPVProgressHandler::DetermineProgressType (  vtkProcessModule *  app  )  [protected]

void vtkPVProgressHandler::InvokeSatelliteProgressEvent (  vtkProcessModule *  , vtkObject *  , int  val )  [protected]

void vtkPVProgressHandler::InvokeRootNodeProgressEvent (  vtkProcessModule *  , vtkObject *  , int  val )  [protected]

void vtkPVProgressHandler::InvokeRootNodeServerProgressEvent (  vtkProcessModule *  , vtkObject *  , int  val )  [protected]

int vtkPVProgressHandler::ReceiveProgressFromSatellite (  int *  id, int *  progress )  [protected]

void vtkPVProgressHandler::LocalDisplayProgress (  vtkProcessModule *  app, const char *  filter, int  progress )  [protected]

void vtkPVProgressHandler::HandleProgress (  int  processid, int  filterid, int  progress )  [protected]

void vtkPVProgressHandler::operator= (  const vtkPVProgressHandler &   )  [protected]

---

Member Data Documentation

vtkProcessModule* vtkPVProgressHandler::ProcessModule [protected]

Definition at line 90 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::ReceivingProgressReports [protected]

Definition at line 92 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::ProgressPending [protected]

Definition at line 95 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::Progress[4] [protected]

Definition at line 96 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::ProgressType [protected]

Definition at line 113 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::ClientMode [protected]

Definition at line 115 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::ServerMode [protected]

Definition at line 116 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::LocalProcessID [protected]

Definition at line 117 of file vtkPVProgressHandler.h.

int vtkPVProgressHandler::NumberOfProcesses [protected]

Definition at line 118 of file vtkPVProgressHandler.h.

double vtkPVProgressHandler::MinimumProgressInterval [protected]

Definition at line 127 of file vtkPVProgressHandler.h.

vtkTimerLog* vtkPVProgressHandler::ProgressTimer [protected]

Definition at line 128 of file vtkPVProgressHandler.h.

vtkMPIController* vtkPVProgressHandler::MPIController [protected]

Definition at line 130 of file vtkPVProgressHandler.h.

vtkSocketController* vtkPVProgressHandler::SocketController [protected]

Definition at line 131 of file vtkPVProgressHandler.h.

vtkPVProgressHandlerInternal* vtkPVProgressHandler::Internals [protected]

Definition at line 132 of file vtkPVProgressHandler.h.

---

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

• Servers/Common/vtkPVProgressHandler.h

---