OutputDataHandler.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:       OutputDataHandler.h (formerly ausgabe.h)
//
//  Contents:   Collects information from model components and writes to files
//
//
//
//------------------------------------------------------------------------------


#ifndef _OutputDataHandler_h
#define _OutputDataHandler_h


#include "BasicDefines.h"


class ausgabe
{       protected:
        FILE* aStrm0;
        FILE* aStrm1;
        FILE* aStrm2;
        FILE* aStrm3;                           //neu 2004
   FILE* aStrm4;
   FILE* aStrm_w;          // Yearly Water File

   FILE* aStrm_wr;          // Yearly Water Rental File
   FILE* aStrm_wre;
   FILE* aStrm_wAg;          // Yearly Water Agent File

   FILE* aStrm_Lrm;          // Yearly Land rental file
   FILE* aStrm_Lrmexp;          // Yearly Land rental file

   //char filename[MXLENGTH];//maximal 50 Zeichen

   public:
        ausgabe();                      //Uebergabe: Output-Dateikrzel
        virtual ~ausgabe();
   virtual void deallocate();

        virtual void data_period0();

        virtual void output_periode();//Periodendaten
      // Called once, in main slope; <sim_main.cpp>
      // executes ausgabe::aufgabedaten()
      //       CHILE:   ausgabe::betriebsdaten()
      //       else:    ausgabe::writeAgPfmDataInStream();//neu 2004

        virtual void outputFinal();     //Daten zum Simulationsende

//      virtual void betriebsdaten(); // CHILE only
      // Called in ausgabe::output_periode()
      // Produces <OUT><TIME>"p.out"
      // Produces <OUT><TIME>"k.out"

        virtual void aufgabedaten();  // all
      // Called in ausgabe::output_periode
      // Produces <OUT><TIME>"a.out"

      // Renamed from <diffusionsdaten>
      // Locally defined output stream
        virtual void writeDiffusion();   //
      // Warning: Same name as <s_liste::diffusionsdaten>
      // Called once, in main slope; <sim_main.cpp>
      // Produces <OUT><TIME>"d.out"

        virtual void makeSectorOutputData();
      // Called once, in main slope; <sim_main.cpp>



   // NEW ARNOLD 2005
   virtual void openWater();
      // uses streams aStrm_w, aStrm_wAg
      //
      // Called once, in  ausgabe::makeSectorOutputData()
      // closes   <OUT><TIME>"w.out"
      //          <OUT><TIME>"wAg.out"

 // NEW ARNOLD 2005
   virtual void closeWater();
      // closes streams aStrm_w, aStrm_wAg
      //
      // Called once, in  ausgabe::makeSectorOutputData()
      // closes   <OUT><TIME>"w.out"
      //          <OUT><TIME>"wAg.out"

      
        virtual void openPachtWater();      // CHILE only. Overloaded: timeshift=0!
   virtual void closePachtWater();      // CHILE only
        virtual void openPachtWater(int timeshift);      // CHILE only
      // Renamed from "pachtdaten_vorbereiten"
      // Called once, in  ausgabe::makeSectorOutputData()
      // Produces <OUT><TIME>"r.out"
      // time shift is one for expected values. Then, the filename is also rE
      
        virtual void openPachtLand();      // CHILE only. Overloaded: timeshift=0!
   virtual void closePachtLand();      // CHILE only
        virtual void openPachtLand(int timeshift);      // CHILE only
      // Produces <OUT><TIME>"Lr.out"  and "Lrexp.out"
      // time shift is one for expected values. Then, the filename is also rE

   // (Locally defined Streams)
   // AgentLandData
        virtual void writeAgLndDataInStream();//neu 2004
   // (Locally defined Streams)
      // Called in <void ausgabe::data_period0>
      // Produces <OUT>"l00.out" before first period
      // KEY to agent data!!!

   // AgentPerformanceData
   // (Locally defined Streams)
   virtual void writeAgPfmDataInStream();//neu 2004
      // Called in <ausgabe::output_periode()>
      // Alternative to <ausgabe::betriebsdaten()>
      // Produces <OUT>p<TIME>.out
      // Produces <OUT>u<TIME>.out
      // Produces <OUT>k<TIME>.out
      // Executes
      //      b_liste::writeAgentPfmData(aStrm0, aStrm1);
      //      for_all(betrieb)
      //      betrieb::writePfmPrdData

        virtual void prepareStreamsExitData();//neu 2004
      // Called in ???
      // Writes exiting agents into further data
      // Produces <OUT><TIME>"xp.out"
      // Produces <OUT><TIME>"xk.out"

   virtual void prepareStreamYieldData();//neu 2004
      // Called in ???
      // Writes soil data
      // Produces <OUT><TIME>"y.out"

        virtual FILE* get_stream0();          //neu 2004
        virtual FILE* get_stream1();
        virtual FILE* get_stream2();
   virtual FILE* get_stream3();          //neu 2004  soils...
   virtual FILE* get_stream_w();         //neu 2005
   virtual FILE* get_stream_wAg();       //neu 2005
   virtual FILE* get_stream_Lrm();       //neu 2005
   virtual FILE* get_stream_Lrmexp();    //neu 2005

   virtual FILE* get_stream_wr();        // in <sector::P_in_datei_schreiben>
   virtual FILE* get_stream_wre();       //in <sector::P_in_datei_schreiben>


   // ARNOLD 2005
   virtual void closeAllSectorStreams();
      // Called once,  in main slope; <sim_main.cpp>
      // Finishes ausgabe::makeSectorOutputData()
      //     by closing all streams.

};

#endif

---