AgentUserAssociation.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:       AgentUserAssociation.h (formerly part of sector9.h)
//
//  Contents:   Agent user association manages the access to land resources, 
//              provides irrigation infrastructure to its member farm agents,
//              assigns water quotas and distributes irrigation water
//
//------------------------------------------------------------------------------


#ifndef _AgentUserAssociation_h
#define _AgentUserAssociation_h

#include "Agent.h"
#include "AgentParcel.h"
#include "MatrixDouble.h"
#include "BasicDefines.h"
#include "FinancialMathFunctions.h"
#include "MarketNonTradablesHandler.h"



class AgentWaterRight
{  //auxiliary class, everthing public
   public:



   int AgentFstdID;     

   MatrixDouble shares;         
   MatrixDouble inflows;

   AgentWaterRight(int numInflows)
        {       AgentFstdID = -1;        
                shares.allocate(numInflows, 1);
                inflows.allocate(numInflows, 1);      
        }

   virtual ~AgentWaterRight()
        {       shares.deallocate();
                inflows.deallocate();
        }
   
        //virtual  void deallocate();
};


class InfrastructureProject
{  //auxiliary class, everthing public
   public:



   int yearImplemented;

        int investObjectID;

        double sizeInHa;

        double totalCost;

        double shareSubsidies;

        int numParticipants;

   MatrixDouble AgentFstdIDs;   

   InfrastructureProject()
        {       //empty
        }
   
   virtual ~InfrastructureProject()
        {       AgentFstdIDs.deallocate();
        }
};




class AgentUserAssociation : public agent
{
public:

        // --------------------------------------------------------------------------
   // --------------------------------------------------------------------------



        virtual int getNumLotteryValues();
        
        virtual void assignWaterRightsPerRandomData(FILE* rndWaterRightsStrm, FILE* dbgWaterRightsStrm);
        virtual void readLotteryDataFromStream(FILE* stream);
        virtual void writeLotteryDataToStream(FILE* stream);
        virtual void initializeWaterLottery(int numLotteryValues_);
        virtual double drawRandomWaterRight(int inflow_);

        virtual void assignWaterRightsPerActualData(FILE* actWaterRightsStrm, FILE* dbgWaterRightsStrm, int& catchmID_, int& sectorID_);
        virtual void readWaterRightsFromStream(FILE* stream, int& catchmID_, int& sectorID_);
        virtual void writeWaterRightsToStream(FILE* stream);
        
        virtual void assignNumberOfMembers(int numMembers_);
        virtual void createWaterRightsRegistry();
        virtual double getWaterRightForAgent(int agFstdID_, int inflowID_);
        virtual void setWaterRightForAgent(int agFstdID_, int inflowID_, double share_);


        // --------------------------------------------------------------------------
   // --------------------------------------------------------------------------



        virtual void assignInfrastructureProjectsPerActualData(FILE* infrastructureProjectsStrm, int& catchmID_, int& sectorID_);
        virtual void readInfrastructureProjectsFromStream(FILE* stream, int& catchmID_, int& sectorID_);
        virtual void writeInfrastructureProjectsToStream(FILE* stream);
        
        virtual void createInfrastructureProjectRegistry();
        virtual int checkIfAgentHasProjects(int agFstdID, int year,
                MatrixDouble& objectIDs, MatrixDouble& sizes, MatrixDouble& purchasePrices, MatrixDouble& sharesEC, MatrixDouble& ratesDC);
        virtual void reportImplementationResult(int agFstdID, int year, int objectID, double size, double purchasePrice, int implemented);
        


        // --------------------------------------------------------------------------
   // --------------------------------------------------------------------------
        
        //die naechsten Funktionen liefern die Sektor-Schattenpreise je Ha. bzw. je
   //l/s/Monat bzw. die Parzellenzahl und das gesamte monatliche Netto-Water
   //zurueck



        virtual double get_Q_B(int stype);   
   virtual double get_Q_W(int month);   
   virtual double get_volB(int month); 
        virtual int getNumAgents(void);
        virtual int getNumParcels(void);
        
        //----------------------------------------------------------------------------------
        


   virtual void addQ_B(int stype, double q_b);
   virtual void addQ_W(int month, double q_w);
   virtual void addVolB(int month, double v_B);
        virtual void addNumAgents(int numberOfAgentsInMarket_);
        virtual void addNumParcels(int numberOfParcelsInMarket_);
   virtual void calcSectorAverages(void);

        //----------------------------------------------------------------------------------



        virtual void makeBidForRentingOut(gebot* bid);
        virtual void makeBidForRentingIn(gebot* bid);

        virtual void boden_wasser_transferieren();
   virtual int get_interesse(int*);
   virtual void transferRentalWater(int month);//renamed from <receiveNetInflows>
   virtual void pachtmarkt_zuruecksetzen();
        virtual void schattenpreise_zuruecksetzen();

        virtual double eigentum_uebertragen(parzelle*, w_rechte*, double);
   virtual double kaufpreis_berechnen(int, w_jahr*, double);

   virtual void writeYearlyLandRental(); // stream "aStrm_Lrm"
   virtual void writeAllMonthlyWaterRental(int shift);   // ARNOLD 2005,
   virtual void P_in_datei_schreiben(); //schreibt Pachtmarktdaten in stream
      // Expected values - not shifted
   virtual void P_in_datei_schreiben(bool isExpected);  //schreibt Pachtmarktdaten in stream
      // not used any more! split up now to

        // --------------------------------------------------------------------------
   // --------------------------------------------------------------------------



        AgentUserAssociation(int agentID_, int catchmentID_, int sectorID_);

        //AgentUserAssociation(const AgentUserAssociation& association_);

        //AgentUserAssociation& operator=(const AgentUserAssociation& association_);

        virtual ~AgentUserAssociation();
        
        
protected:


        int catchmentID;
        int sectorID;

        int agType;

        int agentID;
        
        int numMembers;
        
        int numLotteryValues;

        AgentWaterRight** waterRightsRegistry;

        MatrixDouble wlotto;

   bwmarkt pachtmarkt;

        int numberOfAgentsInMarket;
        int numberOfParcelsInMarket;

   MatrixDouble  Q_B;
   MatrixDouble  Q_W; 

   MatrixDouble  volB;

        int numInfrastructureProjects;

        InfrastructureProject* infrastructureProjectRegistry;


};




#endif /* _AgentUserAssociation_h */

---