AgentPopulationHandler.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:       AgentPopulationHandler.h (formerly bliste.h)
//                                                                        
//  Contents:   Manages linked list of all agents
//
//
//
//------------------------------------------------------------------------------

#ifndef _AgentPopulationHandler_h
#define _AgentPopulationHandler_h

#include <string>
#include "BasicEnums.h"
#include "FinancialMathFunctions.h"
#include "Agent.h"
#include"MainAuxiliaryFunctions.h"

class IrrigationMethodSector;
class TimeHandler;
#ifndef LP_OLD
        #include "MipHandler.h"
#endif /*LP_OLD*/

// Sektor-ID eines Betriebes in der Liste
typedef struct {
        int sek;//Sector ID
        int sc; //Subcatchment ID
} s_id;


class b_liste
{       private:

#ifndef LP_OLD
        bool test;
        MipHandler* globalProblemHandler;
        SolverType solver;
        string solvername;
#endif /*LP_OLD*/

        
        protected:
        int bl_nr;
        int banzahl;
        int letzte_b_nr;
        int* banzahl_NW;

        agent* firstBetrieb;
        agent* merkeBetrieb;//wird fuer suche_naechsten() gebraucht

        public:
        b_liste(int scID);//Uebergabe Betriebslisten bzw. Subcatchment-Nummer
        virtual ~b_liste();

#ifndef LP_OLD
        virtual void setSolverType(SolverType solver);
        virtual void setTolerance(double eps);
        virtual bool readDatFile(char* filename);
        virtual bool writeDatFile();
#endif /*LP_OLD*/

        //create agents
        virtual void makeAgentL(int scid, int skid, int numP);
        virtual void makeAgentF(int scid, int skid, int ppid, int clid, int nwid, int fstd, int numP);

        virtual void deallokieren(agent*);//deallokiert einen Betrieb
        virtual void betriebssortiert_einfuegen(agent*);//foegt einen Betrieb ein

        virtual agent* ersten_suchen(int);//uebergeben wird sek_nr
        virtual agent* imaginaeren_suchen(int s);//uebergeben wird sek_nr
        virtual agent* naechsten_suchen(int);//uebergeben wird sek_nr
        virtual agent* betrieb_suchen(int);//uebergeben wird b_nummer;
        virtual agent* betrieb_herausnehmen(int);//  "        "
        virtual s_id betrieb_SID(int);//uebergeben wird b_nummer
        virtual int farbe_ermitteln(int);//uebergeben wird b_nummer

        //liefert die Nutzerinformationen der Anwender eines Inv.objektes innerhalb
        //des Netzwerks
        virtual nutz ersten_nutzer_suchen(int, int);//bergabe: NW-Nr., ObjCode
        virtual nutz naechsten_nutzer_suchen(int, int);


        virtual int get_bl_nr(void);//liefert Nr. der Betriebsliste zuroeck
   virtual void set_bl_nr(int bl_nr_);
        virtual int get_anzahl_NW(int);//liefert Anzahl der Betriebe eines Netzwerks
        virtual int get_anzahl(void);//liefert Gesamtzahl der Betriebe der Subcatchment
        virtual int get_nummer(void);//liefert die zuletzt vergebene Betriebsnummer

        virtual void loeschen (int);//loescht einen Betrieb, dessen Nr. uebergeben wird
        virtual void betriebe_loeschen(int);//loescht alle Betriebe eines Sektors
        virtual agent* getFirst();//liefert Listenersten
        virtual agent* getSecond();//liefert Listenzweiten

        virtual void betriebe_ausstatten();//Betriebe mit Arbeit/Kapital ausstatten
   virtual void writeInitialEndowmentToFile();

        virtual void uebergang_periode();//Erwartungsbildung, Investitionsplanung
        
#ifdef LP_OLD
        virtual void pacht_periode();
        virtual void hole_gebot(p_gebot* g, int bnr, int typ, int z, int s,
                                                                                                         w_jahr* vol, double pacht);//neu 2003
        virtual void hole_forderung(p_gebot* f, int bnr, int typ, int z, int s,
                                                                                                         w_jahr* vol);//neu 2003

        virtual void kopie_loeschen(int bnr, int typ);
        virtual void alle_kopien_loeschen(int bnr);
        virtual int kapaz_aktualisieren(int, int, int, int, w_jahr*, double);
        virtual void alte_schattenpreise(int);
        virtual void neu_planen(int bnr);
        virtual double verpachtung_korrigieren(int bnr, double volB, int m);
        virtual void zupachtung_korrigieren(int bnr, double volN, int m);
#endif /*LP_OLD*/

   // ======================================================
   // ------------------------------------------------------
        virtual void wasser_periode(int);//assigns monthly water supply
                                                                                                // to agents and saves sectoral data on water
                                                                                                // and rental markets


        virtual void wasser_periode_refactured( TimeHandler& th_const );//assigns monthly water supply
                                                                                                // to agents and saves sectoral data on water
                                                                                                // and rental markets


   // Function called by <wasser_periode>
   // ... For all agents, compute irrigation water demand and report 
   // ... demand to sector, aggregated by method
   virtual agent* agentsComputeIrrigDemandAndReportToSector(agent* anker, int sk, int thisMonth);
   virtual void agentsReceiveNetInflowsFromCatchment(agent* betr, int sk, int thisMonth);

   // Function called by <wasser_periode>
   virtual double agentsReceivePlantWaterDemandsSatisfied (agent* anker, int sk, int sc, int thisMonth, IrrigationMethodSector* sectorPointerToIrrigationMethods, double Ueb_j_tmp);

   // New function that incorporate and distribute water
   virtual void agentsEstimatePlantWaterDemandsAndReportRest(agent* anker, int sk, int sc, int thisMonth, IrrigationMethodSector* sectorPointerToIrrigationMethods);
   virtual void agentsDistributeRestWater(agent* anker, int sk, int sc, int thisMonth, IrrigationMethodSector* sectorPointerToIrrigationMethods);
   virtual void agentsUpdatePlantWaterSupply(agent* anker, int sk, int sc, int thisMonth, IrrigationMethodSector* sectorPointerToIrrigationMethods);


   // Function called by <wasser_periode>
   // ... afp->irrigateCropsByPriorityGroups
   // ... afp->computeAverageOnFieldIrrigationEfficiency
   virtual double agentsIrrigateCropsByPriorityGroups        (agent* anker, int sk, int sc, int thisMonth, IrrigationMethodSector* sectorPointerToIrrigationMethods);
   virtual agent* computeTotIrrigAppliedInSectorAndEfficiency(agent* anker, int sk, int sc, int thisMonth, double irrigAmountSector, double& etaOfSectorAgents );

   //   virtual void water_month(int, FILE*, FILE*);//assigns monthly water supply
                                                                                                // to agents and saves sectoral data on water
                                                                                                // and rental markets

   // <-- end EDIC and Irrigation functions
   // ------------------------------------------------------



        //virtual void water_period_External(int mTot);

        //      virtual void water_month(int, FILE*, FILE*);//assigns monthly water supply
                                                                                                // to agents and saves sectoral data on water
                                                                                                // and rental markets
        virtual void produktion_periode();//WaterSuppy2 und Produktion
        virtual void einkommen_periode();//Betriebseinkommen und andere Kennziffern

        // Write to file 
        virtual void writeAgentLndData(FILE* stream0);//neu 2004
        virtual void writeAgentPfmData(FILE* stream0, FILE* stream1);//neu 2004
        virtual void kapazitaetsdaten_periode(FILE*);//in Outputfile schreiben

        // Debug Functions
        virtual void planungsfehler_melden(int nw, int seg);
        virtual void printToScreen(agent*);
        virtual void printOnScreen_list(void);

        virtual void betriebsaufgabe_periode();//loescht aufgeloeste Betriebe
        virtual void liste_loeschen(void);
        //Arnold2006_12
        virtual void writeAllParcelsToFile(void);
        //Arnold2006_62
        //virtual void writeAllAgentWaterDecToFile(void);//Tbe 080220
        virtual void writeAllCropWaterDataToFile(void);//Tbe 080220

        //Arnold2006_20
        //virtual void initializeEdicIrrigationModel(void);//Tbe 080220
        //virtual void doWaterAllocationIPG(int mTot);//Tbe 080220
        
        //Arnold2006_19
        //In EDIC model wuith WASIM coupling, attributes all crops to cropMixClass
        virtual void allocateSpatiallyExplicit_AllCrops();
   virtual void agentsAllocateSpatiallyIrrigationWaterToParcels(int thisMonth);

        //Arnold2008_08 SHOULD BE DISCARDED
        //Function updates the value "cont" from all parcells of agent to cell grid
        //This funciton used for time-dependent, monthly content
        //  --> switch-statement(cont) in "agentF::updateParcelToLandscape"
        //virtual void updateParcelToLandscape(Content cont, int mTot);    // --> virtual void copyContent_ParcelToLandscape(Content cont, int mTot);
        //virtual void    updateParcelToLandscape(Content cont);           // -->       virtual void copyContent_ParcelToLandscape(Content cont);

        //Arnold2008_08 NEW
        //Function updates the value "cont" from all parcells of agent to cell grid
        //This funciton used for time-dependent, monthly content
        //  --> switch-statement(cont) in "agentF::copyContent_ParcelToLandscape"
        virtual void copyContent_ParcelToLandscape_monthly(Content cont, int mTot);
        virtual void copyContent_ParcelToLandscape(Content cont);

   virtual void copyContent_Landscape2Parcels(Content cont);
   virtual void copyContent_Landscape2Parcels(Content cont, bool flag_fixCopyToCell);
        //Arnold2008_08 NEW
   virtual void testMeanPerAgent(Content cont);

        //Arnold2006_47
        virtual void agentsUpdateIrrigationWater2Landscape(int m);

        //Arnold2006_55
        // checks if all parcels in crpMixClass are set to "get_hasCrop() == isTrue"
        virtual void checkIfTrue(bool isTrue);
        virtual void printAllAgentsProductions();
        
        virtual void aggregateAndOutputLanduseBySector(int numberOfCroppingActivities, MatrixDouble& vectorOfIDs, string*& rowNames, string fn);
        virtual void aggregateLanduseBySector(MatrixDouble& matrixOfCatchmentLandUses);
        virtual void outputLanduseBySector(MatrixDouble& matrixOfCatchmentLandUses, MatrixDouble& vectorOfIDs, string*& rowNames, string fn);
        int getCatchID();
        virtual void writeToFile_AllAgentsProduction();
        void writeEdicHeaderToFile(ofstream& out);

   // For GHANA map correction
   virtual int  getFirstInflowForFarmsteadID(int _fstdID);
};

#endif

---