IC_EndPoint Class Reference

#include <IC_EndPoint.h>


Public Types

enum  { ,
  IC_OK = 0, IC_GENERIC_ERROR = -1, IC_INVALID_NDIM = -2, IC_CANT_ALLOC_REGION = -3,
  IC_CANT_GET_DA_DESCRIPTOR = -4, IC_CANT_COMPUTE_COMM_SCHEDULE = -5, IC_COMM_FAILURE = -6, IC_INVALID_ENDPOINT_NAME = -7,
  IC_INITIALIZATION_FAILURE = -8, IC_CANT_CONNECT_TO_REMOTE = -9, IC_PVM_ERROR = -10, IC_MPI_ERROR = -11,
  IC_POINTER_TABLE_ERROR = -12
}

Public Member Functions

 IC_EndPoint (const char *endpointName, const unsigned mynproc, const unsigned onproc, const unsigned myao, const unsigned oao, int &status)
virtual ~IC_EndPoint ()


Detailed Description

This is the class for public high-level interface of InterComm.


Member Enumeration Documentation

anonymous enum
 

Enumeration for InterComm high-level for API errors.

Enumerator:
IC_OK  no error
IC_GENERIC_ERROR  generic error
IC_INVALID_NDIM  invalid number of array dimensions
IC_CANT_ALLOC_REGION  can't allocate InterComm array regions
IC_CANT_GET_DA_DESCRIPTOR  can't obtain distributed array descriptor
IC_CANT_COMPUTE_COMM_SCHEDULE  can't compute communication schedule
IC_COMM_FAILURE  communication (send/recv) failure
IC_INVALID_ENDPOINT_NAME  invalid endpoint name
IC_INITIALIZATION_FAILURE  local program initialization failed
IC_CANT_CONNECT_TO_REMOTE  can't connect to remote program
IC_PVM_ERROR  PVM error
IC_MPI_ERROR  MPI error
IC_POINTER_TABLE_ERROR  internal pointer translation table error


Constructor & Destructor Documentation

IC_EndPoint::IC_EndPoint const char *  endpointName,
const unsigned  mynproc,
const unsigned  onproc,
const unsigned  myao,
const unsigned  oao,
int &  status
 

The constructor to create the communication endpoints

Parameters:
endpointName the name for the endpoint
mynproc the number of processors used by the local program
onproc the number of processors used by the remote program
myao the array ordering used by the local program
oao the array ordering used by the remote program
status the result of the endpoint creation operation

virtual IC_EndPoint::~IC_EndPoint  )  [virtual]
 

The destructor for the EndPoint. The application writer is supposed to invoke the delete C++ operator to ensure that the destructor properly finializes InterComm


The documentation for this class was generated from the following file:
Generated on Mon Jun 4 14:42:41 2007 for InterComm by  doxygen 1.4.6