Multiprocessing communication superclass. More...

#include <vtkMultiProcessController.h>

Inheritance diagram for vtkMultiProcessController:

Collaboration diagram for vtkMultiProcessController:

Public Types
enum	Errors { RMI_NO_ERROR, RMI_TAG_ERROR, RMI_ARG_ERROR }
enum	Consts { ANY_SOURCE = -1, INVALID_SOURCE = -2 }
enum	Tags { RMI_TAG = 1, RMI_ARG_TAG = 2, BREAK_RMI_TAG = 3, XML_WRITER_DATA_INFO = 4 }
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkMultiProcessController *	NewInstance () const
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
void	SetSingleMethod (vtkProcessFunctionType, void *data)
virtual void	SingleMethodExecute ()=0
virtual void	MultipleMethodExecute ()=0
int	GetLocalProcessId ()
virtual void	CreateOutputWindow ()=0
virtual unsigned long	AddRMI (vtkRMIFunctionType, void *localArg, int tag)
virtual int	RemoveFirstRMI (int tag)
virtual int	RemoveRMI (unsigned long id)
virtual unsigned long	AddRMICallback (vtkRMIFunctionType, void *localArg, int tag)
virtual void	RemoveAllRMICallbacks (int tag)
virtual bool	RemoveRMICallback (unsigned long id)
void	TriggerRMI (int remoteProcessId, void *arg, int argLength, int tag)
void	TriggerBreakRMIs ()
void	Barrier ()
vtkIdType	GetCount ()

virtual void	Initialize (int vtkNotUsed(argc), char **vtkNotUsed(argv), int initializedExternally)=0

void	SetNumberOfProcesses (int num)
int	GetNumberOfProcesses ()

void	SetSingleProcessObject (vtkProcess *p)

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

virtual vtkMultiProcessController *	CreateSubController (vtkProcessGroup *group)

virtual vtkMultiProcessController *	PartitionController (int localColor, int localKey)

virtual 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)
void	BroadcastTriggerRMIOnAllChildren (void *arg, int argLength, int tag)

int	ProcessRMIs (int reportErrors, int dont_loop=0)
int	ProcessRMIs ()
int	BroadcastProcessRMIs (int reportErrors, int dont_loop=0)

virtual void	SetBreakFlag (int)
virtual int	GetBreakFlag ()

virtual void	SetBroadcastTriggerRMI (bool)
virtual bool	GetBroadcastTriggerRMI ()
virtual void	BroadcastTriggerRMIOn ()
virtual void	BroadcastTriggerRMIOff ()

virtual vtkCommunicator *	GetCommunicator ()

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)
vtkDataObject *	ReceiveDataObject (int remoteId, int tag)

int	Broadcast (int *data, vtkIdType length, int srcProcessId)
int	Broadcast (unsigned 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	GatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, vtkIdType recvLengths, vtkIdType offsets, int destProcessId)

int	GatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, 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	AllGatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer, vtkIdType recvLengths, vtkIdType offsets)

int	AllGatherV (vtkDataArray sendBuffer, vtkDataArray recvBuffer)

int	Reduce (const int sendBuffer, int recvBuffer, vtkIdType length, int operation, int destProcessId)
int	Reduce (const unsigned int sendBuffer, unsigned 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)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMultiProcessController *	SafeDownCast (vtkObjectBase *o)
static vtkMultiProcessController *	GetGlobalController ()
static void	SetGlobalController (vtkMultiProcessController *controller)

static int	GetBreakRMITag ()
static int	GetRMITag ()
static int	GetRMIArgTag ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMultiProcessController ()
	~vtkMultiProcessController ()
void	GetMultipleMethod (int index, vtkProcessFunctionType &func, void *&data)
void	ProcessRMI (int remoteProcessId, void *arg, int argLength, int rmiTag)
virtual vtkMultiProcessController *	GetLocalController ()

virtual void	TriggerRMIInternal (int remoteProcessId, void *arg, int argLength, int rmiTag, bool propagate)
Protected Attributes
vtkProcessFunctionType	SingleMethod
void *	SingleData
int	BreakFlag
int	ForceDeepCopy
bool	BroadcastTriggerRMI
vtkOutputWindow *	OutputWindow
vtkCommunicator *	Communicator
vtkCommunicator *	RMICommunicator

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 encouraged communication method. The internal (RMI) communications are done using a second internal communicator (called RMICommunicator).

There are two modes for RMI communication: (1) Send/Receive mode and (2) Broadcast (collective) mode. The Send/Receive mode arranges processes in a binary tree using post-order traversal and propagates the RMI trigger starting from the root (rank 0) to the children. It is commonly employed to communicate between client/server over TCP. Although, the Send/Receive mode can be employed transparently over TCP or MPI, it is not optimal for triggering the RMIs on the satellite ranks. The Broadcast mode provides a more desirable alternative, namely, it uses MPI_Broadcast for communication, which is the nominal way of achieving this in an MPI context. The underlying communication mode used for triggering RMIs is controlled by the "BroadcastTriggerRMI" variable. Note, that mixing between the two modes for RMI communication is not correct behavior. All processes within the vtkMultiProcessController must use the same mode for triggering RMI.

See also:: vtkMPIController vtkCommunicator vtkMPICommunicator

Examples:: vtkMultiProcessController (Examples)

Tests:: vtkMultiProcessController (Tests)

Definition at line 84 of file vtkMultiProcessController.h.

Member Typedef Documentation

typedef vtkObject vtkMultiProcessController::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkMPIController, vtkSocketController, and vtkDummyController.

Definition at line 87 of file vtkMultiProcessController.h.

Member Enumeration Documentation

enum vtkMultiProcessController::Errors

Enumerator:

RMI_NO_ERROR
RMI_TAG_ERROR
RMI_ARG_ERROR

Definition at line 323 of file vtkMultiProcessController.h.

enum vtkMultiProcessController::Consts

Enumerator:

ANY_SOURCE
INVALID_SOURCE

Reimplemented in vtkSocketController.

Definition at line 330 of file vtkMultiProcessController.h.

enum vtkMultiProcessController::Tags

Enumerator:

RMI_TAG
RMI_ARG_TAG
BREAK_RMI_TAG
XML_WRITER_DATA_INFO

Definition at line 336 of file vtkMultiProcessController.h.

Constructor & Destructor Documentation

vtkMultiProcessController::vtkMultiProcessController ( ) [protected]

vtkMultiProcessController::~vtkMultiProcessController ( ) [protected]

Member Function Documentation

static int vtkMultiProcessController::IsTypeOf ( const char * name ) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMPIController, vtkSocketController, and vtkDummyController.

virtual int vtkMultiProcessController::IsA ( const char * name ) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMPIController, vtkSocketController, and vtkDummyController.

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

Reimplemented from vtkObject.

Reimplemented in vtkMPIController, vtkSocketController, and vtkDummyController.

virtual vtkObjectBase* vtkMultiProcessController::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

Reimplemented in vtkMPIController, vtkSocketController, and vtkDummyController.

vtkMultiProcessController* vtkMultiProcessController::NewInstance ( ) const

Reimplemented from vtkObject.

Reimplemented in vtkMPIController, vtkSocketController, and vtkDummyController.

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

virtual void vtkMultiProcessController::Initialize	(	int *	vtkNotUsedargc,
		char ***	vtkNotUsedargv
	)		`[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.

virtual void vtkMultiProcessController::Initialize	(	int *	vtkNotUsedargc,
		char ***	vtkNotUsedargv,
		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 vtkMPIController, vtkSocketController, and vtkDummyController.

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

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.

void vtkMultiProcessController::SetSingleProcessObject ( vtkProcess * p )

Object-oriented flavor of SetSingleMethod(). Instead of passing some function pointer and user data, a vtkProcess object is passed where the method to execute is Execute() and the data the object itself.

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

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

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

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 across 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.

virtual vtkMultiProcessController* vtkMultiProcessController::PartitionController	(	int	localColor,
		int	localKey
	)		`[virtual]`

Partitions this controller based on a coloring. That is, each process passes in a color. All processes with the same color are grouped into the same partition. The processes are ordered by their self-assigned key. Lower keys have lower process ids. Ties are broken by the current process ids. (For example, if all the keys are 0, then the resulting processes will be ordered in the same way.) This method returns a new controller to each process that represents the local partition. This is basically the same operation as MPI_Comm_split.

Reimplemented in vtkMPIController.

virtual unsigned long vtkMultiProcessController::AddRMI	(	vtkRMIFunctionType	,
		void *	localArg,
		int	tag
	)		`[virtual]`

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.

virtual int vtkMultiProcessController::RemoveFirstRMI ( int tag ) [virtual]

Remove the first RMI matching the tag.

virtual int vtkMultiProcessController::RemoveRMI ( unsigned long id ) [virtual]

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

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

Take an RMI away.

Definition at line 218 of file vtkMultiProcessController.h.

virtual unsigned long vtkMultiProcessController::AddRMICallback	(	vtkRMIFunctionType	,
		void *	localArg,
		int	tag
	)		`[virtual]`

These methods are a part of the newer API to add multiple rmi callbacks. When the RMI is triggered, all the callbacks are called Adds a new callback for an RMI. Returns the identifier for the callback.

virtual void vtkMultiProcessController::RemoveAllRMICallbacks ( int tag ) [virtual]

These methods are a part of the newer API to add multiple rmi callbacks. When the RMI is triggered, all the callbacks are called Removes all callbacks for the tag.

virtual bool vtkMultiProcessController::RemoveRMICallback ( unsigned long id ) [virtual]

Remove a callback. Returns true is the remove was successful.

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 247 of file vtkMultiProcessController.h.

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

Convenience method when there is no argument.

Definition at line 254 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 266 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 271 of file vtkMultiProcessController.h.

void vtkMultiProcessController::BroadcastTriggerRMIOnAllChildren	(	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.

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.

int vtkMultiProcessController::BroadcastProcessRMIs	(	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.

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 void vtkMultiProcessController::SetBroadcastTriggerRMI ( bool ) [virtual]

Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the sattelites.

virtual bool vtkMultiProcessController::GetBroadcastTriggerRMI ( ) [virtual]

Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the sattelites.

virtual void vtkMultiProcessController::BroadcastTriggerRMIOn ( ) [virtual]

Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the sattelites.

virtual void vtkMultiProcessController::BroadcastTriggerRMIOff ( ) [virtual]

Setting this flag to 1 will cause the TriggerRMIOnAllChildren to use a collective broadcast operation to communicate the RMI tag to the sattelites.

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 316 of file vtkMultiProcessController.h.

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

Accessor to some default tags.

Definition at line 317 of file vtkMultiProcessController.h.

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

Accessor to some default tags.

Definition at line 318 of file vtkMultiProcessController.h.

void vtkMultiProcessController::Barrier ( ) [inline]

This method can be used to synchronize processes.

Definition at line 1391 of file vtkMultiProcessController.h.

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. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1111 of file vtkMultiProcessController.h.

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. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1124 of file vtkMultiProcessController.h.

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. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1137 of file vtkMultiProcessController.h.

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. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1152 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Send	(	const unsigned 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. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1165 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Send	(	const float *	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. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1179 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Send	(	const double *	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. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1192 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Send	(	vtkDataObject *	data,
		int	remoteId,
		int	tag
	)		`[inline]`

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1085 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Send	(	vtkDataArray *	data,
		int	remoteId,
		int	tag
	)		`[inline]`

This method sends data to another process. Tag eliminates ambiguity when multiple sends or receives exist in the same process. It is recommended to use custom tag number over 100. vtkMultiProcessController has reserved tags between 1 and 4. vtkCommunicator has reserved tags between 10 and 16.

Definition at line 1098 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Send	(	const vtkMultiProcessStream &	stream,
		int	remoteId,
		int	tag
	)		`[inline]`

Send a stream to another process. vtkMultiProcessStream makes it possible to send data with arbitrary length and different base types to the other process(es). Instead of making several Send() requests for each type of arguments, it's generally more efficient to push the arguments into the stream and the send the stream over.

Definition at line 1221 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	int *	data,
		vtkIdType	maxlength,
		int	remoteProcessId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1270 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	unsigned int *	data,
		vtkIdType	maxlength,
		int	remoteProcessId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1283 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	unsigned long *	data,
		vtkIdType	maxlength,
		int	remoteProcessId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1296 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	char *	data,
		vtkIdType	maxlength,
		int	remoteProcessId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1311 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	unsigned char *	data,
		vtkIdType	maxlength,
		int	remoteProcessId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1324 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	float *	data,
		vtkIdType	maxlength,
		int	remoteProcessId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1338 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	double *	data,
		vtkIdType	maxlength,
		int	remoteProcessId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1351 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	vtkDataObject *	data,
		int	remoteId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1231 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	vtkDataArray *	data,
		int	remoteId,
		int	tag
	)		`[inline]`

This method receives data from a corresponding send. It blocks until the receive is finished. It calls methods in "data" to communicate the sending data. In the overrloads that take in a maxlength argument, this length is the maximum length of the message to receive. If the maxlength is less than the length of the message sent by the sender, an error will be flagged. Once a message is received, use the GetCount() method to determine the actual size of the data received.

Definition at line 1257 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Receive	(	vtkMultiProcessStream &	stream,
		int	remoteId,
		int	tag
	)		`[inline]`

Receive a stream from the other processes.

Definition at line 1381 of file vtkMultiProcessController.h.

vtkDataObject * vtkMultiProcessController::ReceiveDataObject	(	int	remoteId,
		int	tag
	)		`[inline]`

Receive a stream from the other processes.

Definition at line 1244 of file vtkMultiProcessController.h.

vtkIdType vtkMultiProcessController::GetCount ( ) [inline]

Returns the number of words received by the most recent Receive(). Note that this is not the number of bytes received, but the number of items of the data-type received by the most recent Receive() eg. if Receive(int*,..) was used, then this returns the number of ints received; if Receive(double*,..) was used, then this returns the number of doubles received etc. The return value is valid only after a successful Receive().

Definition at line 1399 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	int *	data,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 432 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	unsigned int *	data,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 435 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	unsigned long *	data,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 438 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	unsigned char *	data,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 441 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	char *	data,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 444 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	float *	data,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 447 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	double *	data,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 450 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	vtkDataObject *	data,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 458 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	vtkDataArray *	data,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 461 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Broadcast	(	vtkMultiProcessStream &	stream,
		int	srcProcessId
	)		`[inline]`

Broadcast sends the array in the process with id srcProcessId to all of the other processes. All processes must call these method with the same arguments in order for it to complete.

Definition at line 465 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Gather	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	length,
		int	destProcessId
	)		`[inline]`

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 480 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Gather	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType	length,
		int	destProcessId
	)		`[inline]`

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 485 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Gather	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType	length,
		int	destProcessId
	)		`[inline]`

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 490 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Gather	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType	length,
		int	destProcessId
	)		`[inline]`

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 495 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Gather	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType	length,
		int	destProcessId
	)		`[inline]`

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 500 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Gather	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType	length,
		int	destProcessId
	)		`[inline]`

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 505 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Gather	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer,
		int	destProcessId
	)		`[inline]`

Gather collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The length argument (which must be the same on all processes) is the length of the sendBuffers. The recvBuffer (on te destination process) must be of length length*numProcesses. Gather is the inverse operation of Scatter.

Definition at line 517 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets,
		int	destProcessId
	)		`[inline]`

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 534 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets,
		int	destProcessId
	)		`[inline]`

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 541 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets,
		int	destProcessId
	)		`[inline]`

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 548 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets,
		int	destProcessId
	)		`[inline]`

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 555 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets,
		int	destProcessId
	)		`[inline]`

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 562 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets,
		int	destProcessId
	)		`[inline]`

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 569 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets,
		int	destProcessId
	)		`[inline]`

GatherV is the vector variant of Gather. It extends the functionality of Gather by allowing a varying count of data from each process. GatherV collects arrays in the process with id destProcessId. Each process (including the destination) sends the contents of its send buffer to the destination process. The destination process receives the messages and stores them in rank order. The sendLength argument defines how much the local process sends to destProcessId and recvLengths is an array containing the amount destProcessId receives from each process, in rank order.

Definition at line 585 of file vtkMultiProcessController.h.

int vtkMultiProcessController::GatherV	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer,
		int	destProcessId
	)		`[inline]`

This special form of GatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order. It will also resize recvBuffer in order to accommodate the incoming data (unlike the other GatherV variants).

Definition at line 599 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Scatter	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 611 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Scatter	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 616 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Scatter	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 621 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Scatter	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 626 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Scatter	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 631 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Scatter	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType	length,
		int	srcProcessId
	)		`[inline]`

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 636 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Scatter	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer,
		int	srcProcessId
	)		`[inline]`

Scatter takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer. Process 0 receives the first length values, process 1 receives the second length values, and so on. Scatter is the inverse operation of Gather.

Definition at line 648 of file vtkMultiProcessController.h.

int vtkMultiProcessController::ScatterV	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType *	sendLengths,
		vtkIdType *	offsets,
		vtkIdType	recvLength,
		int	srcProcessId
	)		`[inline]`

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

Definition at line 661 of file vtkMultiProcessController.h.

int vtkMultiProcessController::ScatterV	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType *	sendLengths,
		vtkIdType *	offsets,
		vtkIdType	recvLength,
		int	srcProcessId
	)		`[inline]`

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

Definition at line 668 of file vtkMultiProcessController.h.

int vtkMultiProcessController::ScatterV	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType *	sendLengths,
		vtkIdType *	offsets,
		vtkIdType	recvLength,
		int	srcProcessId
	)		`[inline]`

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

Definition at line 675 of file vtkMultiProcessController.h.

int vtkMultiProcessController::ScatterV	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType *	sendLengths,
		vtkIdType *	offsets,
		vtkIdType	recvLength,
		int	srcProcessId
	)		`[inline]`

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

Definition at line 682 of file vtkMultiProcessController.h.

int vtkMultiProcessController::ScatterV	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType *	sendLengths,
		vtkIdType *	offsets,
		vtkIdType	recvLength,
		int	srcProcessId
	)		`[inline]`

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

Definition at line 689 of file vtkMultiProcessController.h.

int vtkMultiProcessController::ScatterV	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType *	sendLengths,
		vtkIdType *	offsets,
		vtkIdType	recvLength,
		int	srcProcessId
	)		`[inline]`

ScatterV is the vector variant of Scatter. It extends the functionality of Scatter by allowing a varying count of data to each process. ScatterV takes an array in the process with id srcProcessId and distributes it. Each process (including the source) receives a portion of the send buffer defined by the sendLengths and offsets arrays.

Definition at line 696 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGather	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	length
	)		`[inline]`

Same as gather except that the result ends up on all processes.

Definition at line 716 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGather	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType	length
	)		`[inline]`

Same as gather except that the result ends up on all processes.

Definition at line 719 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGather	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType	length
	)		`[inline]`

Same as gather except that the result ends up on all processes.

Definition at line 723 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGather	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType	length
	)		`[inline]`

Same as gather except that the result ends up on all processes.

Definition at line 727 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGather	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType	length
	)		`[inline]`

Same as gather except that the result ends up on all processes.

Definition at line 730 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGather	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType	length
	)		`[inline]`

Same as gather except that the result ends up on all processes.

Definition at line 733 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGather	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer
	)		`[inline]`

Same as gather except that the result ends up on all processes.

Definition at line 743 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets
	)		`[inline]`

Same as GatherV except that the result is placed in all processes.

Definition at line 750 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets
	)		`[inline]`

Same as GatherV except that the result is placed in all processes.

Definition at line 757 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets
	)		`[inline]`

Same as GatherV except that the result is placed in all processes.

Definition at line 764 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets
	)		`[inline]`

Same as GatherV except that the result is placed in all processes.

Definition at line 771 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets
	)		`[inline]`

Same as GatherV except that the result is placed in all processes.

Definition at line 778 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType	sendLength,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets
	)		`[inline]`

Same as GatherV except that the result is placed in all processes.

Definition at line 785 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer,
		vtkIdType *	recvLengths,
		vtkIdType *	offsets
	)		`[inline]`

Same as GatherV except that the result is placed in all processes.

Definition at line 801 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllGatherV	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer
	)		`[inline]`

This special form of AllGatherV will automatically determine recvLengths and offsets to tightly pack the data in the recvBuffer in process order. It will also resize recvBuffer in order to accommodate the incoming data (unlike the other GatherV variants).

Definition at line 814 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	length,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 823 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const unsigned int *	sendBuffer,
		unsigned int *	recvBuffer,
		vtkIdType	length,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 828 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType	length,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 833 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType	length,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 838 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType	length,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 843 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType	length,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 848 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType	length,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 853 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer,
		int	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes an identifier defined in the vtkCommunicator::StandardOperations enum to define the operation.

Definition at line 865 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	length,
		vtkCommunicator::Operation *	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 877 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const unsigned long *	sendBuffer,
		unsigned long *	recvBuffer,
		vtkIdType	length,
		vtkCommunicator::Operation *	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 883 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const unsigned char *	sendBuffer,
		unsigned char *	recvBuffer,
		vtkIdType	length,
		vtkCommunicator::Operation *	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 889 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const char *	sendBuffer,
		char *	recvBuffer,
		vtkIdType	length,
		vtkCommunicator::Operation *	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 895 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const float *	sendBuffer,
		float *	recvBuffer,
		vtkIdType	length,
		vtkCommunicator::Operation *	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 901 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	const double *	sendBuffer,
		double *	recvBuffer,
		vtkIdType	length,
		vtkCommunicator::Operation *	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 907 of file vtkMultiProcessController.h.

int vtkMultiProcessController::Reduce	(	vtkDataArray *	sendBuffer,
		vtkDataArray *	recvBuffer,
		vtkCommunicator::Operation *	operation,
		int	destProcessId
	)		`[inline]`

Reduce an array to the given destination process. This version of Reduce takes a custom operation as a subclass of vtkCommunicator::Operation.

Definition at line 921 of file vtkMultiProcessController.h.

int vtkMultiProcessController::AllReduce	(	const int *	sendBuffer,
		int *	recvBuffer,
		vtkIdType	length,
		int	operation
	)		`[inline]`