AgentParcelGridCellInterface.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//
//  Thomas Berger (main author), Pepijn Schreinemachers, and Thorsten Arnold
//
//
//  Hohenheim University (490d)
//  Professorship for Land Use Economics in the Tropics and Subtropics
//
//  May not be distributed without permission by main author
//
//  File:      AgentParcelGridCellInterface.h (formerly irrigation.h)
//
//  Contents:  Auxiliary class, links agent parcel list to grid cells,
//             needed for coupling with WASIM-ETH
//
//
//------------------------------------------------------------------------------


#ifndef _AgentParcelGridCellInterface_h
#define _AgentParcelGridCellInterface_h


#include "AgentParcel.h"

#ifdef AIX
   #include <unistd.h>
#endif

#ifndef AIX
        #include <dos.h>
#endif /* AIX */



class  crpMixClass;
class  parPointlist;

//data structure for crop mix per soil class
class parPointer
{  protected:
   parPointer* nextElem;
        parPointer* prevElem;
   parzelle* actualParcel;

   public:
   parPointer()   {initialize();};
   
   void initialize()
   {  nextElem=NULL;
      prevElem=NULL;
      actualParcel=NULL;
   };
   ~parPointer()
   {
      initialize();
   };
   
   void setParcel(parzelle* par) {actualParcel = par;};
   parzelle* getParcel() {return actualParcel;};


   void setNextElem(parPointer* parP) {nextElem = parP;};
   parPointer* getNextElem() {return nextElem;};

   void setPrevElem(parPointer* parP) {prevElem = parP;};
   parPointer* getPrevElem() {return prevElem;};

};

//data structure for crop mix per soil class
class parPointlist
{  protected:
   int lengthList;
   parPointer* firstElement;
   parPointer* lastElement;

   public:
   parPointlist()
    { lengthList=0;
      firstElement=NULL;
      lastElement=NULL;
    };
   virtual ~parPointlist();   

   virtual void append(parzelle* currP);
   //Arnold2006_46
   //erasing list of pointers, but leaving parzellen untouched;
   virtual void clearList(void);

   virtual void printOnScreen_list();
   virtual void updateIrrigWaterCropMixClass2Parcels(double iQ, int m);

   //Arnold2006_53
   // find position of a parcel "searchParcel" in list p_liste, accordiong to row/col position
   virtual int getPosInList(parPointer* searchPointer);//returns position (from beginning) of parcelle in List

   //Arnold2006_54
   virtual int get_len(void);//returns length of list in memory, but re-calculates each time
   virtual int getLengthOfList(void) {return  lengthList;};

   //Arnold2006_55
   // checks if all parcels are set to "get_hasCrop() == isTrue"
   virtual bool checkIfTrue(bool isTrue);
   virtual bool checkIfTrue(bool isTrue, int cropCnt);

};

//data structure for crop mix per soil class
class crpMixClass
{  private:
   //auxiliary class, everthing public

   //general data of soil class
   int scl;             //ID of soil class
   int nCr;    //number of cropping activities of agent
   int currM;  //Remembers current month (RELEVANT counting;
               // to get real month:

   //Arnold2006_31
   double areaTot;    // Total area that is cropped
   double restTot;    // Total area that is not yet allocated spatially


   //data per cropping activity
   int*    crA;//cropping activity ID
   //Arnold2006_31
   int*  LPcol;//Index into LP
   int* IPGvec; // Vector of irrigation priority group of each activity
   int* lenParcelList;

   double* aHa;//hectares of cropping activities

   //Arnold2006_31
   double* aHaRest;//hectares of cropping activities that is not yet allocated
   double* irrigQ;    // Vector of irrigation water (quantitiy in m3) by month

   parPointlist* parcelListArray;  //vector of parzelle*

   public:
   crpMixClass(void);
   crpMixClass(int sClass);

   virtual ~crpMixClass();
   
   virtual void initEmpty(void);
   virtual void allocate(int in);
   virtual void deallocate();

   void set_sClass(int sClass) { scl = sClass;}
   int   get_nCr() {return nCr;};
   int   get_scl() {return scl;};

   int   get_crA(int cropCnt) {return crA[cropCnt];};
   int   get_LPcol(int cropCnt) {return LPcol[cropCnt];};
   double get_aHa(int cropCnt) {return aHa[cropCnt];};

   void  set_crA(int cropCnt, int crAnew)     {  crA[cropCnt] = (int) crAnew;  };
   void  set_aHa(int cropCnt, double xi) {  aHa[cropCnt] = xi; };
   void  set_LPcol(int cropCnt, int col) {  LPcol[cropCnt] = col; };

   //Arnold2006_31
   void   set_irrigQ(double q, int cropCnt) { irrigQ[cropCnt] = q; };
   double get_irrigQ(int cropCnt) { return irrigQ[cropCnt]; };

   //reduces rest area of activity "cropCnt" by one parcel size
   double get_aHaRest(int cropCnt)
   {
      return aHaRest[cropCnt];
   };
   virtual double get_aHaRestTotal();
   virtual int get_RestMaxPos();
   virtual int get_RestMinPos();

   void  set_aHaRest(int cropCnt, double xi) {  aHaRest[cropCnt] = xi; };   
   void reduceRestByOneUnit(int cropCnt) {aHaRest[cropCnt]-=PLOTSIZE();};
   void restSubtract(int cropCnt, double val) {aHaRest[cropCnt]-=val;};
   void restAdd(int cropCnt, double val) {aHaRest[cropCnt]+=val;};   

   void  set_currM(int m) {currM = m;};    //RELEVANT month
   int  get_currM(void) {return currM;};   //RELEVANT month

   //Arnold2006_66: Number of parcels that have been allocated (and saved in list)
   void add_lenParcelList(int cropCnt) { lenParcelList[cropCnt] ++; };
   void subtr_lenParcelList(int cropCnt) { lenParcelList[cropCnt] --; };
   int get_lenParcelList(int cropCnt) { return lenParcelList[cropCnt];   };
   void reset_lenParcelList(int cropCnt) {  lenParcelList[cropCnt]=0; };

   //Arnold2006_54: llength of parcel list
   void set_IPGvec(int cropCnt, int g) { IPGvec[cropCnt] = g; };
   int get_IPGvec(int cropCnt) { return IPGvec[cropCnt]; };

   //Arnold2006_31: ADD Total Area Cropped / Rest
   virtual void addAreaCropped(void);
   virtual void addRest(void);

   //Arnold2006_33:
   virtual void printToScreen(void);
   virtual void printOnScreen_list(int cropCnt);

   //Arnold2006_45
   virtual void appendParcelAllocated(int cropCnt, parzelle* parcelAlloc);
   virtual void printParcels(int cropCnt);
   //Arnold2006_46
   virtual void clearParcelList();

   //Arnold2006_52
   virtual void updateIrrigWaterCropMixClass2Parcels(int cropCnt, int m, double iQ) ;
   virtual void updateIrrigWaterCropMixClass2Parcels_all(int mTot, int bnummer);   

   //Arnold2006_55
   // checks if all parcels in crpMixClass are set to "get_hasCrop() == true"
   virtual void checkIfTrue(int cropCnt, bool isTrue);
};

#endif

---