Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkCommunicator Class Reference

Used to send/receive messages in a multiprocess/thread environment. More...

#include <vtkCommunicator.h>

Inheritance diagram for vtkCommunicator:

Inheritance graph
[legend]
Collaboration diagram for vtkCommunicator:

Collaboration graph
[legend]
List of all members.

Public Methods

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)
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 Public Methods

int IsTypeOf (const char *type)
vtkCommunicator * SafeDownCast (vtkObject *o)

Protected Methods

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 ()

Protected Attributes

char * MarshalString
int MarshalStringLength
int MarshalDataLength

Detailed Description

Used to send/receive messages in a multiprocess/thread environment.

Date:
2001/11/13 14:25:56
Revision:
1.12

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:
vtkSharedMemoryCommunicator vtkMPICommunicator
Tests:
vtkCommunicator (Tests)

Definition at line 71 of file vtkCommunicator.h.

Constructor & Destructor Documentation

vtkCommunicator::vtkCommunicator (    )  [protected]
 

vtkCommunicator::~vtkCommunicator (    )  [protected]
 

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented from vtkObject.

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, 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, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

virtual int vtkCommunicator::Send (  vtkDataObject *    data,
int    remoteId,
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, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

Referenced by vtkSocketCommunicator::Send(), vtkMultiProcessController::Send(), and vtkMPICommunicator::Send().

virtual int vtkCommunicator::Send (  vtkDataArray *    data,
int    remoteId,
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, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Subclass have to supply these methods to send various arrays of data.

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

Referenced by vtkSocketCommunicator::Receive(), vtkMultiProcessController::Receive(), and vtkMPICommunicator::Receive().

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

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Subclass have to supply these methods to receive various arrays of data.

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

Reimplemented in vtkMPICommunicator, vtkSharedMemoryCommunicator, and vtkSocketCommunicator.

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

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

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

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

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

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

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

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

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

Member Data Documentation

char* vtkCommunicator::MarshalString [protected]
 

Definition at line 157 of file vtkCommunicator.h.

int vtkCommunicator::MarshalStringLength [protected]
 

Definition at line 158 of file vtkCommunicator.h.

int vtkCommunicator::MarshalDataLength [protected]
 

Definition at line 160 of file vtkCommunicator.h.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:28:02 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001