View of /trunk/paramin-beta/netdatacontrol.h

#ifndef netdatacontrol_h
#define netdatacontrol_h

#include "paramin.h"
#include "doublevector.h"

/**
 * \class NetInfo
 * \brief The class NetInfo keeps together information concerning status of data that is being sent/received during netcommunication. It contains functions to get information about status of data. 
 */

class NetInfo {
public:
  int set;
  int sent;
  int received;
  int numPendingAnswers;

  NetInfo();
  ~NetInfo();
  int hasSet();
  int hasReceived();
  int hasSent();
  int numCopiesSent();
};

/**
 * \class Coordinates
 * \brief The class Coordinates stores the datapair (x, y) where x is a vector of p paramaters. It contains functions to set and access (x, y) and parameter p in x. 
*/

class Coordinates {
private:
  DoubleVector x;
  double y;
public:
  Coordinates();
  ~Coordinates();
  const DoubleVector& getX();
  double getParameter(int num);
  double getY();
  void setX(const DoubleVector& v1);
  void setParameter(double p, int num);
  void setY(double y1);
  int getNumParameters();
};

/**
 * \class NetDataControl
 * \brief The class NetDataControl stores a set of datapairs (x[0..p-1], y) which can be identified with a specific tag and each pair has a unique identity. x[0..p-1] is thought of being sent to a process and y is received from a process using net communication.  NetDataControl provides functions to initialize and access each datapair and get information about the status of net communication for the set of datapairs as well as each pair.  NetDataControl uses the class coordinates to store each datapair and the class NetInfo to set information about the status of the data pair concerning netcommunication 
*/

class NetDataControl {
private:
  /**
   * \brief identification for the set of datapairs.
   */
  int tag;               
  /**
   * \brief number of vectors set, numberOfx <= totalNumx
   */
  int numberOfx;         
  /**
   * \brief total number of vectors that can be set,
   */
  int totalNumx;         
  /**
   * \brief number of x-vectors that have been sent to processes
   */
  int numberSent;        
  /**
   * \brief number of y-s that have been received from processes
   */
  int numberAnswers;     
  /**
   * \brief nextAns points to identity of the next data pair
   */
  int nextAns;           
  /**
   * \brief number of parameters in vector x
   */
  int numPar;            
  /**
   * \brief stores a set data pairs equals totalNumx
   */
  Coordinates** xyCoord; 
  /**
   * \brief for each datapair there is a corresponding class which keeps track of the status of netcommunication.
   */
  NetInfo** nInfo;       
  /**
   * \brief resendID points to the last x which can be resent
   */
  int resendID;         
public:
  NetDataControl(int numberOfx, int numberOfParameters, int t);
  ~NetDataControl();
  void setX(const DoubleVector& x1);
  void setY(int id, double fx);
  void setDataPair(const DoubleVector& x1, double fx);
  const DoubleVector& getX(int id);
  const DoubleVector& getNextXToSend();
  double getY(int id);
  const DoubleVector& getNextAnsweredX();
  double getNextAnsweredY();
  int getNextSendID();
  int getNextXToResend();
  void sentOne(int id);
  void resentOne(int id);
  int getIDToSetNext();
  int getTag();
  int getNumLeftToSend();
  int allSent();
  int getNumNotAnswered();
  int getTotalReceived();
  int getTotalSet();
  void setFirstAnswered();
  int allReceived();
  int getNumAnswered();
  int getLastSetID();
  int getMaxNumData();
  int hasAnswer(int id);
  int isFull();
};

#endif