#include <vtkMultiProcessController.h>
Inheritance diagram for vtkMultiProcessController:
Public Methods | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | Initialize (int vtkNotUsed(argc), char *arcv[]) |
virtual void | SetNumberOfProcesses (int num) |
virtual int | GetNumberOfProcesses () |
void | SetSingleMethod (vtkProcessFunctionType, void *data) |
virtual void | SingleMethodExecute ()=0 |
void | SetMultipleMethod (int index, vtkProcessFunctionType, void *data) |
virtual void | MultipleMethodExecute ()=0 |
virtual int | GetLocalProcessId () |
virtual int | Send (vtkDataObject *data, int remoteProcessId, int tag) |
virtual int | Send (int *data, int length, int remoteProcessId, int tag)=0 |
virtual int | Send (unsigned long *data, int length, int remoteProcessId, int tag)=0 |
virtual int | Send (char *data, int length, int remoteProcessId, int tag)=0 |
virtual int | Send (float *data, int length, int remoteProcessId, int tag)=0 |
virtual int | Receive (vtkDataObject *data, int remoteProcessId, int tag) |
virtual int | Receive (int *data, int length, int remoteProcessId, int tag)=0 |
virtual int | Receive (unsigned long *data, int length, int remoteProcessId, int tag)=0 |
virtual int | Receive (char *data, int length, int remoteProcessId, int tag)=0 |
virtual int | Receive (float *data, int length, int remoteProcessId, int tag)=0 |
virtual void | SetForceDeepCopy (int) |
virtual int | GetForceDeepCopy () |
virtual void | ForceDeepCopyOn () |
virtual void | ForceDeepCopyOff () |
void | AddRMI (vtkRMIFunctionType, void *localArg, int tag) |
void | RemoveRMI (vtkRMIFunctionType f, void *arg, int tag) |
void | TriggerRMI (int remoteProcessId, void *arg, int argLength, int tag) |
void | TriggerRMI (int remoteProcessId, char *arg, int tag) |
void | TriggerRMI (int remoteProcessId, int tag) |
void | ProcessRMIs () |
virtual void | SetBreakFlag (int) |
virtual int | GetBreakFlag () |
virtual float | GetWriteTime () |
virtual float | GetReadTime () |
virtual float | GetSendWaitTime () |
virtual float | GetSendTime () |
virtual float | GetReceiveWaitTime () |
virtual float | GetReceiveTime () |
Static Public Methods | |
vtkMultiProcessController * | New () |
int | IsTypeOf (const char *type) |
vtkMultiProcessController * | SafeDownCast (vtkObject *o) |
vtkMultiProcessController * | GetGlobalController () |
Protected Methods | |
vtkMultiProcessController () | |
~vtkMultiProcessController () | |
vtkMultiProcessController (const vtkMultiProcessController &) | |
void | operator= (const vtkMultiProcessController &) |
void | DeleteAndSetMarshalString (char *str, int strLength) |
int | WriteObject (vtkDataObject *object) |
int | ReadObject (vtkDataObject *object) |
int | WriteDataSet (vtkDataSet *object) |
int | ReadDataSet (vtkDataSet *object) |
int | WriteImageData (vtkImageData *object) |
int | ReadImageData (vtkImageData *object) |
void | ProcessRMI (int remoteProcessId, void *arg, int argLength, int rmiTag) |
virtual vtkMultiProcessController * | GetLocalController () |
virtual void | SetGlobalController (vtkMultiProcessController *controller) |
Protected Attributes | |
int | MaximumNumberOfProcesses |
int | NumberOfProcesses |
int | LocalProcessId |
vtkProcessFunctionType | SingleMethod |
void * | SingleData |
vtkProcessFunctionType | MultipleMethod [VTK_MP_CONTROLLER_MAX_PROCESSES] |
void * | MultipleData [VTK_MP_CONTROLLER_MAX_PROCESSES] |
vtkCollection * | RMIs |
char * | MarshalString |
int | MarshalStringLength |
int | MarshalDataLength |
int | BreakFlag |
float | ReadTime |
float | WriteTime |
float | SendWaitTime |
float | SendTime |
float | ReceiveWaitTime |
float | ReceiveTime |
int | ForceDeepCopy |
vtkMultiProcessController supplies an API for sending and receiving message between processes. The controller also defines calls for sending and receiving vtkDataObjects, and remote method invocations.
|
Register remote method invocation in the receiving process which makes the call. It must have a unique tag as an RMI id. The vtkRMIFunctionType has several arguments: localArg (same as passed in), remoteArg, remoteArgLength (memory passed by process triggering the RMI), remoteProcessId. |
|
Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkMPIController. |
|
This convenience method returns the controller associated with the local process. It returns NULL until the processes are spawned. It is better if you hang on to the controller passed as an argument to the SingleMethod or MultipleMethod functions. |
|
Tells you which process [0, NumProcess) you are in. Reimplemented in vtkThreadedController. |
|
For performance monitoring, reading and writing polydata to strings are timed. Access to these times is provided by these methods. |
|
This method is for setting up the processes. If a subclass needs to initialize process communication (i.e. MPI) it would over ride this method. Reimplemented in vtkSocketCommunicator. |
|
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 vtkObject. Reimplemented in vtkMPIController. |
|
Return 1 if this class type 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 vtkObject. Reimplemented in vtkMPIController. |
|
Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes. Implemented in vtkMPIController. |
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkObject. Reimplemented in vtkMPIController. |
|
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 vtkObject. Reimplemented in vtkMPIController. |
|
Calling this method gives control to the controller to start processing RMIs. |
|
Subclass have to supply these methods to receive various arrays of data. The methods also have to support a remoteProcessId of VTK_MP_CONTROLLER_ANY_SOURCE Implemented in vtkMPIController. |
|
This method receives a data object from a corresponding send. It blocks until the receive is finished. Reimplemented in vtkMPIController. |
|
Take an RMI away. |
|
Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkMPIController. |
|
Subclass have to supply these methods to send various arrays of data. Implemented in vtkMPIController. |
|
This method sends an object to another process. Tag eliminates ambiguity and is used to match sends to receives. Reimplemented in vtkMPIController. |
|
Setting this flag to 1 will cause the ProcessRMIs loop to return. This also causes vtkUpStreamPorts to return from their WaitForUpdate loops. |
|
By default, sending objects use shallow copy whenever possible. This flag forces the controller to use deep copies instead. This is necessary when asynchronous processing occurs (i.e. pipeline parallelism). This is only important when using vtkThreadedController. |
|
Set the MultipleMethod to f() and the UserData of the for the method to be executed by the process index when MultipleMethodExecute is called. This is for having each process start with a different function and data argument. |
|
Set the number of processes you will be using. This defaults to the maximum number available. If you set this to a value higher than the default, you will get an error. Reimplemented in vtkSocketCommunicator. |
|
Set the SingleMethod to f() and the UserData of the for the method to be executed by all of the processes when SingleMethodExecute is called. All the processes will start by calling this function. |
|
Execute the SingleMethod (as define by SetSingleMethod) using this->NumberOfProcesses processes. This will only return when all the processes finish executing their methods. Implemented in vtkMPIController. |
|
Convenience method when there is no argument. |
|
Convenience method when the arg is a string. |
|
A method to trigger a method invocation in another process. |