IC_EndPointSet Class Reference

#include <IC_EndPointSet.h>


Public Types

enum  { IC_OK = 0, IC_EPSET_INIT_FAILURE = -13, IC_ARRAY_REGISTER_FAILURE = -14, IC_COMMIT_ARRAY_FAILURE = -15 }

Public Member Functions

 IC_EndPointSet (const char *xjdfile, const char *compname, int &status)
virtual ~IC_EndPointSet ()
void commitArrays (int &status)
void exportArray (char *arrname, int &status)
void importArray (char *arrname, int &status)


Detailed Description

This class is encapsulation of multiple ICEndPoint instances. It parses the XJD file and maintain list of ICEndPoint, and encapsulates exportArray and importArray. Thereby, XJD can be used for high-level API.


Member Enumeration Documentation

anonymous enum
 

Enumeration for InterComm high-level API errors (Specifically for XJD)

Enumerator:
IC_OK  no errors
IC_EPSET_INIT_FAILURE  fail to initialize EndPointSet
IC_ARRAY_REGISTER_FAILURE  fail to register an array
IC_COMMIT_ARRAY_FAILURE  fail to commit the registered arrays


Constructor & Destructor Documentation

IC_EndPointSet::IC_EndPointSet const char *  xjdfile,
const char *  compname,
int &  status
 

This will create multiple IC_EndPoint objects related with compname by parsing the XJD file

Parameters:
xjdfile the XJD file name
compname my program name
status the result of the set creation operation.

virtual IC_EndPointSet::~IC_EndPointSet  )  [virtual]
 

The destructor of the IC_EndPointSet


Member Function Documentation

void IC_EndPointSet::commitArrays int &  status  ) 
 

This computes the schedules for all regions defined with this compname

Parameters:
status returns the result of the commit operation

void IC_EndPointSet::exportArray char *  arrname,
int &  status
 

Export the arrays after creating the communication endpoints

Parameters:
arrname the array name
status returns the result of the export operation

void IC_EndPointSet::importArray char *  arrname,
int &  status
 

Import the arrays after creating the communication endpoints

Parameters:
arrname the array name
status returns the result of the export operation


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