vtkMultiProcessController Class Reference

#include <vtkMultiProcessController.h>

Inheritance diagram for vtkMultiProcessController:

Inheritance graph
[legend]
Collaboration diagram for vtkMultiProcessController:

Collaboration graph
[legend]
List of all members.

Detailed Description

Multiprocessing communication superclass.

vtkMultiProcessController is used to control multiple processes in a distributed computing environment. It has methods for executing single/multiple method(s) on multiple processors, triggering registered callbacks (Remote Methods) (AddRMI(), TriggerRMI()) and communication. Please note that the communication is done using the communicator which is accessible to the user. Therefore it is possible to get the communicator with GetCommunicator() and use it to send and receive data. This is the encoured communication method. The internal (RMI) communications are done using a second internal communicator (called RMICommunicator).

See also:
vtkMPIController vtkCommunicator vtkMPICommunicator
Examples:
vtkMultiProcessController (Examples)
Tests:
vtkMultiProcessController (Tests)

Definition at line 68 of file vtkMultiProcessController.h.
int Send (const int *data, vtkIdType length, int remoteProcessId, int tag)
int Send (const unsigned int *data, vtkIdType length, int remoteProcessId, int tag)
int Send (const unsigned long *data, vtkIdType length, int remoteProcessId, int tag)
int Send (const char *data, vtkIdType length, int remoteProcessId, int tag)
int Send (const unsigned char *data, vtkIdType length, int remoteProcessId, int tag)
int Send (const float *data, vtkIdType length, int remoteProcessId, int tag)
int Send (const double *data, vtkIdType length, int remoteProcessId, int tag)
int Send (vtkDataObject *data, int remoteId, int tag)
int Send (vtkDataArray *data, int remoteId, int tag)
int Send (const vtkMultiProcessStream &stream, int remoteId, int tag)
int Receive (int *data, vtkIdType maxlength, int remoteProcessId, int tag)
int Receive (unsigned int *data, vtkIdType maxlength, int remoteProcessId, int tag)
int Receive (unsigned long *data, vtkIdType maxlength, int remoteProcessId, int tag)
int Receive (char *data, vtkIdType maxlength, int remoteProcessId, int tag)
int Receive (unsigned char *data, vtkIdType maxlength, int remoteProcessId, int tag)
int Receive (float *data, vtkIdType maxlength, int remoteProcessId, int tag)
int Receive (double *data, vtkIdType maxlength, int remoteProcessId, int tag)
int Receive (vtkDataObject *data, int remoteId, int tag)
int Receive (vtkDataArray *data, int remoteId, int tag)
int Receive (vtkMultiProcessStream &stream, int remoteId, int tag)
vtkDataObjectReceiveDataObject (int remoteId, int tag)
vtkIdType GetCount ()
int Broadcast (int *data, vtkIdType length, int srcProcessId)
int Broadcast (unsigned long *data, vtkIdType length, int srcProcessId)
int Broadcast (unsigned char *data, vtkIdType length, int srcProcessId)
int Broadcast (char *data, vtkIdType length, int srcProcessId)
int Broadcast (float *data, vtkIdType length, int srcProcessId)
int Broadcast (double *data, vtkIdType length, int srcProcessId)
int Broadcast (vtkDataObject *data, int srcProcessId)
int Broadcast (vtkDataArray *data, int srcProcessId)
int Broadcast (vtkMultiProcessStream &stream, int srcProcessId)
int Gather (const int *sendBuffer, int *recvBuffer, vtkIdType length, int destProcessId)
int Gather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int destProcessId)
int Gather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int destProcessId)
int Gather (const char *sendBuffer, char *recvBuffer, vtkIdType length, int destProcessId)
int Gather (const float *sendBuffer, float *recvBuffer, vtkIdType length, int destProcessId)
int Gather (const double *sendBuffer, double *recvBuffer, vtkIdType length, int destProcessId)
int Gather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int destProcessId)
int GatherV (const int *sendBuffer, int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int GatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int GatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int GatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int GatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int GatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets, int destProcessId)
int Scatter (const int *sendBuffer, int *recvBuffer, vtkIdType length, int srcProcessId)
int Scatter (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int srcProcessId)
int Scatter (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int srcProcessId)
int Scatter (const char *sendBuffer, char *recvBuffer, vtkIdType length, int srcProcessId)
int Scatter (const float *sendBuffer, float *recvBuffer, vtkIdType length, int srcProcessId)
int Scatter (const double *sendBuffer, double *recvBuffer, vtkIdType length, int srcProcessId)
int Scatter (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int srcProcessId)
int ScatterV (const int *sendBuffer, int *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
int ScatterV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
int ScatterV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
int ScatterV (const char *sendBuffer, char *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
int ScatterV (const float *sendBuffer, float *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
int ScatterV (const double *sendBuffer, double *recvBuffer, vtkIdType *sendLengths, vtkIdType *offsets, vtkIdType recvLength, int srcProcessId)
int AllGather (const int *sendBuffer, int *recvBuffer, vtkIdType length)
int AllGather (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length)
int AllGather (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length)
int AllGather (const char *sendBuffer, char *recvBuffer, vtkIdType length)
int AllGather (const float *sendBuffer, float *recvBuffer, vtkIdType length)
int AllGather (const double *sendBuffer, double *recvBuffer, vtkIdType length)
int AllGather (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer)
int AllGatherV (const int *sendBuffer, int *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
int AllGatherV (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
int AllGatherV (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
int AllGatherV (const char *sendBuffer, char *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
int AllGatherV (const float *sendBuffer, float *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
int AllGatherV (const double *sendBuffer, double *recvBuffer, vtkIdType sendLength, vtkIdType *recvLengths, vtkIdType *offsets)
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, int operation, int destProcessId)
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation, int destProcessId)
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation, int destProcessId)
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation, int destProcessId)
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation, int destProcessId)
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation, int destProcessId)
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation, int destProcessId)
int Reduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
int Reduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
int Reduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
int Reduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
int Reduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
int Reduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation, int destProcessId)
int Reduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkCommunicator::Operation *operation, int destProcessId)
int AllReduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, int operation)
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, int operation)
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, int operation)
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, int operation)
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, int operation)
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, int operation)
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, int operation)
int AllReduce (const int *sendBuffer, int *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int AllReduce (const unsigned long *sendBuffer, unsigned long *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int AllReduce (const unsigned char *sendBuffer, unsigned char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int AllReduce (const char *sendBuffer, char *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int AllReduce (const float *sendBuffer, float *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int AllReduce (const double *sendBuffer, double *recvBuffer, vtkIdType length, vtkCommunicator::Operation *operation)
int AllReduce (vtkDataArray *sendBuffer, vtkDataArray *recvBuffer, vtkCommunicator::Operation *operation)
 vtkMultiProcessController ()
 ~vtkMultiProcessController ()
virtual void TriggerRMIInternal (int remoteProcessId, void *arg, int argLength, int rmiTag, bool propagate)

Public Types

typedef vtkObject Superclass
 RMI_NO_ERROR
 RMI_TAG_ERROR
 RMI_ARG_ERROR
 MAX_PROCESSES = 8192
 ANY_SOURCE = -1
 INVALID_SOURCE = -2
 RMI_TAG = 1
 RMI_ARG_TAG = 2
 BREAK_RMI_TAG = 3
 XML_WRITER_DATA_INFO = 4
enum  Errors { RMI_NO_ERROR, RMI_TAG_ERROR, RMI_ARG_ERROR }
enum  Consts { MAX_PROCESSES = 8192, ANY_SOURCE = -1, INVALID_SOURCE = -2 }
enum  Tags { RMI_TAG = 1, RMI_ARG_TAG = 2, BREAK_RMI_TAG = 3, XML_WRITER_DATA_INFO = 4 }

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv))=0
virtual void Finalize ()=0
virtual void Finalize (int finalizedExternally)=0
virtual void SingleMethodExecute ()=0
virtual void MultipleMethodExecute ()=0
int GetLocalProcessId ()
virtual void CreateOutputWindow ()=0
unsigned long AddRMI (vtkRMIFunctionType, void *localArg, int tag)
int RemoveFirstRMI (int tag)
int RemoveRMI (unsigned long id)
void TriggerRMI (int remoteProcessId, void *arg, int argLength, int tag)
void TriggerBreakRMIs ()
void Barrier ()
virtual void Initialize (int *vtkNotUsed(argc), char ***vtkNotUsed(argv), int initializedExternally)=0
void SetNumberOfProcesses (int num)
int GetNumberOfProcesses ()
void SetSingleMethod (vtkProcessFunctionType, void *data)
void SetMultipleMethod (int index, vtkProcessFunctionType, void *data)
virtual vtkMultiProcessControllerCreateSubController (vtkProcessGroup *group)
void RemoveRMI (vtkRMIFunctionType f, void *arg, int tag)
void TriggerRMI (int remoteProcessId, const char *arg, int tag)
void TriggerRMI (int remoteProcessId, int tag)
void TriggerRMIOnAllChildren (void *arg, int argLength, int tag)
void TriggerRMIOnAllChildren (const char *arg, int tag)
void TriggerRMIOnAllChildren (int tag)
int ProcessRMIs (int reportErrors, int dont_loop=0)
int ProcessRMIs ()
virtual void SetBreakFlag (int)
virtual int GetBreakFlag ()
virtual vtkCommunicatorGetCommunicator ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkMultiProcessControllerSafeDownCast (vtkObject *o)
static vtkMultiProcessControllerGetGlobalController ()
static void SetGlobalController (vtkMultiProcessController *controller)
static int GetBreakRMITag ()
static int GetRMITag ()
static int GetRMIArgTag ()

Protected Member Functions

void ProcessRMI (int remoteProcessId, void *arg, int argLength, int rmiTag)
virtual vtkMultiProcessControllerGetLocalController ()

Protected Attributes

vtkProcessFunctionType SingleMethod
void * SingleData
vtkProcessFunctionType MultipleMethod [MAX_PROCESSES]
void * MultipleData [MAX_PROCESSES]
vtkCollectionRMIs
int BreakFlag
int ForceDeepCopy
vtkOutputWindowOutputWindow
vtkCommunicatorCommunicator
vtkCommunicatorRMICommunicator


Member Typedef Documentation

typedef vtkObject vtkMultiProcessController::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkDummyController, vtkMPIController, and vtkSocketController.

Definition at line 71 of file vtkMultiProcessController.h.


Member Enumeration Documentation

enum vtkMultiProcessController::Errors

Enumerator:
RMI_NO_ERROR 
RMI_TAG_ERROR 
RMI_ARG_ERROR 

Definition at line 263 of file vtkMultiProcessController.h.

enum vtkMultiProcessController::Consts

Enumerator:
MAX_PROCESSES 
ANY_SOURCE 
INVALID_SOURCE 

Reimplemented in vtkSocketController.

Definition at line 270 of file vtkMultiProcessController.h.

enum vtkMultiProcessController::Tags

Enumerator:
RMI_TAG 
RMI_ARG_TAG 
BREAK_RMI_TAG 
XML_WRITER_DATA_INFO 

Definition at line 277 of file vtkMultiProcessController.h.


Constructor & Destructor Documentation

vtkMultiProcessController::vtkMultiProcessController (  )  [protected]

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

vtkMultiProcessController::~vtkMultiProcessController (  )  [protected]

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.


Member Function Documentation

virtual const char* vtkMultiProcessController::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkDummyController, vtkMPIController, and vtkSocketController.

static int vtkMultiProcessController::IsTypeOf ( const char *  type  )  [static]

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkDummyController, vtkMPIController, and vtkSocketController.

virtual int vtkMultiProcessController::IsA ( const char *  type  )  [virtual]

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkDummyController, vtkMPIController, and vtkSocketController.

static vtkMultiProcessController* vtkMultiProcessController::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

Reimplemented in vtkDummyController, vtkMPIController, and vtkSocketController.

void vtkMultiProcessController::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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 vtkDummyController, vtkMPIController, and vtkSocketController.

virtual void vtkMultiProcessController::Initialize ( int *  vtkNotUsed(argc),
char ***  vtkNotUsed(argv) 
) [pure virtual]

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.

Referenced by vtkSocketController::Initialize(), and vtkMPIController::Initialize().

virtual void vtkMultiProcessController::Initialize ( int *  vtkNotUsed(argc),
char ***  vtkNotUsed(argv),
int  initializedExternally 
) [pure virtual]

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. Provided for initialization outside vtk.

Implemented in vtkMPIController.

virtual void vtkMultiProcessController::Finalize (  )  [pure virtual]

This method is for cleaning up. If a subclass needs to clean up process communication (i.e. MPI) it would over ride this method.

Implemented in vtkDummyController, vtkMPIController, and vtkSocketController.

Referenced by vtkMPIController::Finalize().

virtual void vtkMultiProcessController::Finalize ( int  finalizedExternally  )  [pure virtual]

This method is for cleaning up. If a subclass needs to clean up process communication (i.e. MPI) it would over ride this method. Provided for finalization outside vtk.

Implemented in vtkDummyController, vtkMPIController, and vtkSocketController.

void vtkMultiProcessController::SetNumberOfProcesses ( int  num  ) 

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.

int vtkMultiProcessController::GetNumberOfProcesses (  ) 

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.

void vtkMultiProcessController::SetSingleMethod ( vtkProcessFunctionType  ,
void *  data 
)

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.

virtual void vtkMultiProcessController::SingleMethodExecute (  )  [pure virtual]

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 vtkDummyController, vtkMPIController, and vtkSocketController.

void vtkMultiProcessController::SetMultipleMethod ( int  index,
vtkProcessFunctionType  ,
void *  data 
)

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.

virtual void vtkMultiProcessController::MultipleMethodExecute (  )  [pure virtual]

Execute the MultipleMethods (as define by calling SetMultipleMethod for each of the required this->NumberOfProcesses methods) using this->NumberOfProcesses processes.

Implemented in vtkDummyController, vtkMPIController, and vtkSocketController.

int vtkMultiProcessController::GetLocalProcessId (  ) 

Tells you which process [0, NumProcess) you are in.

Reimplemented in vtkDummyController.

static vtkMultiProcessController* vtkMultiProcessController::GetGlobalController (  )  [static]

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.

virtual void vtkMultiProcessController::CreateOutputWindow (  )  [pure virtual]

This method can be used to tell the controller to create a special output window in which all messages are preceded by the process id.

Implemented in vtkDummyController, vtkMPIController, and vtkSocketController.

virtual vtkMultiProcessController* vtkMultiProcessController::CreateSubController ( vtkProcessGroup group  )  [virtual]

Creates a new controller with the processes specified by the given group. The new controller will already be initialized for you. You are responsible for deleting the controller once you are done. It is invalid to pass this method a group with a different communicator than is used by this controller. This operation is collective accross all processes defined in the group. It is undefined what will happen if the group is not the same on all processes. This method must be called by all processes in the controller regardless of whether they are in the group. NULL is returned on all process not in the group.

Reimplemented in vtkMPIController.

unsigned long vtkMultiProcessController::AddRMI ( vtkRMIFunctionType  ,
void *  localArg,
int  tag 
)

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. Since only one callback can be registered per tag, this method will remove any previously registered callback for the given tag. Returns a unique Id for the RMI registration which can be used to unregister the callback. RemoveRMI() should be preferred over RemoveFirstRMI() since it avoid accidental removal of callbacks.

int vtkMultiProcessController::RemoveFirstRMI ( int  tag  ) 

Remove the first RMI matching the tag.

int vtkMultiProcessController::RemoveRMI ( unsigned long  id  ) 

Remove the RMI matching the id. The id is the same id returned by AddRMI().

void vtkMultiProcessController::RemoveRMI ( vtkRMIFunctionType  f,
void *  arg,
int  tag 
) [inline]

Take an RMI away.

Definition at line 184 of file vtkMultiProcessController.h.

void vtkMultiProcessController::TriggerRMI ( int  remoteProcessId,
void *  arg,
int  argLength,
int  tag 
)

A method to trigger a method invocation in another process.

void vtkMultiProcessController::TriggerBreakRMIs (  ) 

A conveniance method. Called on process 0 to break "ProcessRMIs" loop on all other processes.

void vtkMultiProcessController::TriggerRMI ( int  remoteProcessId,
const char *  arg,
int  tag 
) [inline]

Convenience method when the arg is a string.

Definition at line 198 of file vtkMultiProcessController.h.

void vtkMultiProcessController::TriggerRMI ( int  remoteProcessId,
int  tag 
) [inline]

Convenience method when there is no argument.

Definition at line 205 of file vtkMultiProcessController.h.

void vtkMultiProcessController::TriggerRMIOnAllChildren ( void *  arg,
int  argLength,
int  tag 
)

This is a convenicence method to trigger an RMI call on all the "children" of the current node. The children of the current node can be determined by drawing a binary tree starting at node 0 and then assigned nodes ids incrementally in a breadth-first fashion from left to right. This is designed to be used when trigger an RMI call on all satellites from the root node.

void vtkMultiProcessController::TriggerRMIOnAllChildren ( const char *  arg,
int  tag 
) [inline]

This is a convenicence method to trigger an RMI call on all the "children" of the current node. The children of the current node can be determined by drawing a binary tree starting at node 0 and then assigned nodes ids incrementally in a breadth-first fashion from left to right. This is designed to be used when trigger an RMI call on all satellites from the root node.

Definition at line 217 of file vtkMultiProcessController.h.

void vtkMultiProcessController::TriggerRMIOnAllChildren ( int  tag  )  [inline]

This is a convenicence method to trigger an RMI call on all the "children" of the current node. The children of the current node can be determined by drawing a binary tree starting at node 0 and then assigned nodes ids incrementally in a breadth-first fashion from left to right. This is designed to be used when trigger an RMI call on all satellites from the root node.

Definition at line 222 of file vtkMultiProcessController.h.

int vtkMultiProcessController::ProcessRMIs ( int  reportErrors,
int  dont_loop = 0 
)

Calling this method gives control to the controller to start processing RMIs. Possible return values are: RMI_NO_ERROR, RMI_TAG_ERROR : rmi tag could not be received, RMI_ARG_ERROR : rmi arg could not be received. If reportErrors is false, no vtkErrorMacro is called. ProcessRMIs() calls ProcessRMIs(int) with reportErrors = 0. If dont_loop is 1, this call just process one RMI message and exits.

int vtkMultiProcessController::ProcessRMIs (  ) 

Calling this method gives control to the controller to start processing RMIs. Possible return values are: RMI_NO_ERROR, RMI_TAG_ERROR : rmi tag could not be received, RMI_ARG_ERROR : rmi arg could not be received. If reportErrors is false, no vtkErrorMacro is called. ProcessRMIs() calls ProcessRMIs(int) with reportErrors = 0. If dont_loop is 1, this call just process one RMI message and exits.

virtual void vtkMultiProcessController::SetBreakFlag ( int   )  [virtual]

Setting this flag to 1 will cause the ProcessRMIs loop to return. This also causes vtkUpStreamPorts to return from their WaitForUpdate loops.

virtual int vtkMultiProcessController::GetBreakFlag (  )  [virtual]

Setting this flag to 1 will cause the ProcessRMIs loop to return. This also causes vtkUpStreamPorts to return from their WaitForUpdate loops.

virtual vtkCommunicator* vtkMultiProcessController::GetCommunicator (  )  [virtual]

Returns the communicator associated with this controller. A default communicator is created in constructor.

Reimplemented in vtkDummyController.

static int vtkMultiProcessController::GetBreakRMITag (  )  [inline, static]

Accessor to some default tags.

Definition at line 256 of file vtkMultiProcessController.h.

static int vtkMultiProcessController::GetRMITag (  )  [inline, static]

Accessor to some default tags.

Definition at line 257 of file vtkMultiProcessController.h.

static int vtkMultiProcessController::GetRMIArgTag (  )  [inline, static]

Accessor to some default tags.

Definition at line 258 of file vtkMultiProcessController.h.

void vtkMultiProcessController::Barrier (  )  [inline]

This method can be used to synchronize processes.

Definition at line 1275 of file vtkMultiProcessController.h.

References vtkCommunicator::Barrier(), and Communicator.

static void vtkMultiProcessController::SetGlobalController ( vtkMultiProcessController controller  )  [static]

int vtkMultiProcessController::Send ( const int *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
) [inline]

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Definition at line 995 of file vtkMultiProcessController.h.

References Communicator, and vtkCommunicator::Send().

int vtkMultiProcessController::Send ( const unsigned int *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
) [inline]

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Definition at line 1008 of file vtkMultiProcessController.h.

References Communicator, and vtkCommunicator::Send().

int vtkMultiProcessController::Send ( const unsigned long *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
) [inline]

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Definition at line 1021 of file vtkMultiProcessController.h.

References Communicator, and vtkCommunicator::Send().

int vtkMultiProcessController::Send ( const char *  data,
vtkIdType  length,
int  remoteProcessId,
int  tag 
) [inline]

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process.

Definition at line 1036 of file vtkMultiProcessController.h.

References