vtkCommunicator Class Reference

#include <vtkCommunicator.h>

Inheritance diagram for vtkCommunicator:

[legend]Collaboration diagram for vtkCommunicator:

[legend]List of all members.

---

Detailed Description

Used to send/receive messages in a multiprocess environment.

This is an abstact class which contains functionality for sending and receiving inter-process messages. It contains methods for marshaling an object into a string (currently used by the MPI communicator but not the shared memory communicator).

Warning:

Communication between systems with different vtkIdTypes is not supported. All machines have to have the same vtkIdType.

See also:

vtkMPICommunicator

Tests:

vtkCommunicator (Tests)

Definition at line 44 of file vtkCommunicator.h.

virtual int	Receive (vtkDataArray *data, int remoteHandle, int tag)
virtual int	Receive (int *data, int length, int remoteHandle, int tag)=0
virtual int	Receive (unsigned long *data, int length, int remoteHandle, int tag)=0
virtual int	Receive (unsigned char *data, int length, int remoteHandle, int tag)=0
virtual int	Receive (char *data, int length, int remoteHandle, int tag)=0
virtual int	Receive (float *data, int length, int remoteHandle, int tag)=0
virtual int	Receive (double *data, int length, int remoteHandle, int tag)=0
static void	SetUseCopy (int useCopy)
void	DeleteAndSetMarshalString (char *str, int strLength)
int	WriteObject (vtkDataObject *object)
int	ReadObject (vtkDataObject *object)
int	WriteDataSet (vtkDataSet *object)
int	ReadDataSet (vtkDataSet *object)
int	WriteImageData (vtkImageData *object)
int	ReadImageData (vtkImageData *object)
int	WriteDataArray (vtkDataArray *object)
int	ReadDataArray (vtkDataArray *object)
	vtkCommunicator ()
	~vtkCommunicator ()
char *	MarshalString
int	MarshalStringLength
int	MarshalDataLength
static int	UseCopy
Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	Send (vtkDataObject *data, int remoteHandle, int tag)
virtual int	Send (vtkDataArray *data, int remoteHandle, int tag)
virtual int	Send (int *data, int length, int remoteHandle, int tag)=0
virtual int	Send (unsigned long *data, int length, int remoteHandle, int tag)=0
virtual int	Send (unsigned char *data, int length, int remoteHandle, int tag)=0
virtual int	Send (char *data, int length, int remoteHandle, int tag)=0
virtual int	Send (float *data, int length, int remoteHandle, int tag)=0
virtual int	Send (double *data, int length, int remoteHandle, int tag)=0
virtual int	Receive (vtkDataObject *data, int remoteHandle, int tag)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCommunicator *	SafeDownCast (vtkObject *o)

---

Member Typedef Documentation

typedef vtkObject vtkCommunicator::Superclass

Reimplemented from vtkObject. Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator. Definition at line 49 of file vtkCommunicator.h.

---

Constructor & Destructor Documentation

vtkCommunicator::vtkCommunicator (   )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

vtkCommunicator::~vtkCommunicator (   )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

---

Member Function Documentation

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

Reimplemented from vtkObject. Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

static int vtkCommunicator::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 vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::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 vtkMPICommunicator, and vtkSocketCommunicator.

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

Reimplemented from vtkObject. Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

void vtkCommunicator::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 vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  vtkDataObject *  data, int  remoteHandle, int  tag )  [virtual]

This method sends a data object to a destination. Tag eliminates ambiguity and is used to match sends to receives. Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator. Referenced by vtkSocketCommunicator::Send(), vtkMultiProcessController::Send(), and vtkMPICommunicator::Send().

virtual int vtkCommunicator::Send (  vtkDataArray *  data, int  remoteHandle, int  tag )  [virtual]

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives. Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  int *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

Subclass have to supply these methods to send various arrays of data. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  unsigned long *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  unsigned char *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  char *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  float *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  double *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method sends a data array to a destination. Tag eliminates ambiguity and is used to match sends to receives. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Receive (  vtkDataObject *  data, int  remoteHandle, int  tag )  [virtual]

This method receives a data object from a corresponding send. It blocks until the receive is finished. Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator. Referenced by vtkSocketCommunicator::Receive(), vtkMultiProcessController::Receive(), and vtkMPICommunicator::Receive().

virtual int vtkCommunicator::Receive (  vtkDataArray *  data, int  remoteHandle, int  tag )  [virtual]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Reimplemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Receive (  int *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

Subclass have to supply these methods to receive various arrays of data. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Receive (  unsigned long *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Receive (  unsigned char *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Receive (  char *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Receive (  float *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Receive (  double *  data, int  length, int  remoteHandle, int  tag )  [pure virtual]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Implemented in vtkMPICommunicator, and vtkSocketCommunicator.

static void vtkCommunicator::SetUseCopy (  int  useCopy  )  [static]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

void vtkCommunicator::DeleteAndSetMarshalString (  char *  str, int  strLength )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::WriteObject (  vtkDataObject *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::ReadObject (  vtkDataObject *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::WriteDataSet (  vtkDataSet *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::ReadDataSet (  vtkDataSet *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::WriteImageData (  vtkImageData *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::ReadImageData (  vtkImageData *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::WriteDataArray (  vtkDataArray *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

int vtkCommunicator::ReadDataArray (  vtkDataArray *  object  )  [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished.

---

Member Data Documentation

char* vtkCommunicator::MarshalString [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Definition at line 132 of file vtkCommunicator.h.

int vtkCommunicator::MarshalStringLength [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Definition at line 133 of file vtkCommunicator.h.

int vtkCommunicator::MarshalDataLength [protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Definition at line 135 of file vtkCommunicator.h.

int vtkCommunicator::UseCopy [static, protected]

This method receives a data array from a corresponding send. It blocks until the receive is finished. Definition at line 137 of file vtkCommunicator.h.

---

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

• dox/Parallel/vtkCommunicator.h

---