TimeHandlerClass.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:       TimeHandlerClass.h
//
//  Contents:   Header of class used for handling of time
//              
//
//
//------------------------------------------------------------------------------


// DOCUMENTAITON AND TEST PROJECT:
// ... utilities\Win32\bcb5\TestTimeHandlerBorland.bpr
// ... utilities\src\master\testTimeHandler.cpp


#ifndef _TimeHandlerClass_
#define _TimeHandlerClass_

#include "BasicData.h"


string integerToString(int val);
string int2String(int val);

class TimeHandler
{
public:
        int STARTYEAR()             { return absoluteStartYear;}    
        int STARTMONTH()            { return absoluteStartMonth;}
        int STARTDAY()              { return absoluteStartDay;}        
         
        int STOPYEAR()              { return absoluteStopYear;}        
        int STOPMONTH()             { return absoluteStopMonth;}
        int STOPDAY()               { return absoluteStopDay;}

        int IRRIGATIONSTARTMONTH()  {return irrigationStartMonth;}
        int IRRIGATIONSTOPMONTH()   {return irrigationStopMonth;}
        
        bool isIrrigationMonth();  // assumes This Month
        bool isIrrigationMonth(int m); // takes any month <m> as argument   
         
        // old, erase later
        virtual int MONATE();
        virtual int TOTAL_IRRIGATION_MONTHS();
        virtual int TOTALPERIODS();   
   virtual bool ISNORTHERN();

        void setMONATE(int m_);
         
        int GETMONTH()              { return currentAbsoluteMonth;}
        int GETYEAR()               { return currentAbsoluteYear;}

        string GETMONTH_string()    { return integerToString(currentAbsoluteMonth); }
        string GETYEAR_string()     { return integerToString(currentAbsoluteYear);   }

         
         
        int PERIODE()               { return currentRelativePeriod;} // old, erase later
        int CURRENTMODELPERIOD()    { return currentRelativePeriod;}
        int CURRENTMODELMONTH()     { return currentRelativeMonth;}

   void initializeDummy();
        void readTimeHandler(string filename);
        void readFromFile(string filename) { readTimeHandler(filename);}

        void writeToFile(string fn);
        void writeAsRead(ofstream& outstream);

   
   // CAREFUL with these set functions
   virtual void setSTOPYEAR(int absoluteStopYear_);

   // ... set back to start
        void resetAllDatesToStart();
        void reset() {resetAllDatesToStart();}

   // ... Reset to beginning of (model) year.
   // ... In southern hemisphere, that is July!
   virtual void resetToStartOfYear(int _year);
   virtual void resetToStartOfYear(int _year, string comment);

        void nextMonth();
        void nextPeriod();

        void printCurrentTimeStatus(std::ostream *outstream);
        void printToScreen();
        void printDaysPerMonth();

        bool isLeapYear(int y_year);
        int  getDaysPerMonth(int m_month, int y_year);
        int  DAYSperTHISMONTH();

        TimeHandler();
   TimeHandler(  TimeHandler& sourceHandle, string nm);
        virtual ~TimeHandler();
   virtual void deallocate();

   // Copy constructor
   virtual void copy( TimeHandler&  sourceHandle);

   //
   virtual void setNameOfHandler(string nm_);
   virtual string getNameOfHandler(); 

   // Should be private
        virtual void SETMONTH(int m_);
   virtual void SETYEAR(int y_);
 
private:

   virtual void setSTARTYEAR(int absoluteStartYear_);
   virtual void setSTARTMONTH(int absoluteStartMonth_);
   virtual      void setSTOPMONTH(int absoluteStopMonth_);
   virtual void setISNORTHERN(bool isNorthern_);
   



        void updateIrrigationMonths();
        void updateIrrigationMonths(bool doOutput);

        // Ongoing date within model run, in real years ( 1-1996)
   // 1-1996  is
   // ... 0-0 in north if model starts in Jan 1996
   // ... 6-0 in south if model starts in July 1995
        int currentAbsoluteMonth;
        int currentAbsoluteYear;

        // Ongoing date within model run, in real years ( 1-1996)
        int currentRelativePeriod;
        int currentRelativeMonth;
        
        // Absolute, fixed times
        int absoluteStartYear;
        int absoluteStartMonth;
        int absoluteStartDay;
        
        int absoluteStopYear;
        int absoluteStopMonth;
        int absoluteStopDay;    
        
        int irrigationStartMonth;
        int irrigationStopMonth;
        
        int maximumNumberOfIrrigationMonths; // MONATE();
        int maximumNumberOfPeriodsModeled;

        bool isNorthernHemisphere;

        int* daysPerMonth; //= {  0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
        string* monthString;
        void initDaysPerMonths();

   // Each time handler has a name, which is set when
   //   a) read from file
   //   b) created with copy constructor
   string nameOfThisHandler;


        bool checkIfCountUpYear();
        void addYearInTimeHandler() {   currentAbsoluteYear++;}
};
#endif

---