source: XIOS/dev/XIOS_DEV_CMIP6/src/calendar.hpp @ 1478

Last change on this file since 1478 was 1357, checked in by rlacroix, 6 years ago

Add some extra checks when switching to the next timestep.

  • Property copyright set to
    Software name : XIOS (Xml I/O Server)
    http://forge.ipsl.jussieu.fr/ioserver
    Creation date : January 2009
    Licence : CeCCIL version2
    see license file in root directory : Licence_CeCILL_V2-en.txt
    or http://www.cecill.info/licences/Licence_CeCILL_V2-en.html
    Holder : CEA/LSCE (Laboratoire des Sciences du CLimat et de l'Environnement)
    CNRS/IPSL (Institut Pierre Simon Laplace)
    Project Manager : Yann Meurdesoif
    yann.meurdesoif@cea.fr
File size: 4.5 KB
Line 
1#ifndef __XIOS_CCalendar__
2#define __XIOS_CCalendar__
3
4/// XIOS headers ///
5#include "xios_spl.hpp"
6#include "exception.hpp"
7#include "date.hpp"
8
9namespace xios
10{
11      /// ////////////////////// Déclarations ////////////////////// ///
12
13      typedef enum _monthEnum
14      {  JAN = 1, FEB = 2, MAR = 3, APR = 4 , MAY = 5 , JUN = 6 ,
15         JUL = 7, AUG = 8, SEP = 9, OCT = 10, NOV = 11, DEC = 12  } MonthEnum;
16
17      ///---------------------------------------------------------------
18
19      class CDate;
20
21      class CCalendar : public CObject
22      {
23            /// Typedef ///
24            typedef CObject SuperClass;
25
26         public :
27
28            /// Destructeur ///
29            virtual ~CCalendar(void);
30
31         protected :
32
33            /// Constructeurs ///
34            CCalendar(void);
35            CCalendar(const StdString& id);
36            CCalendar(const StdString& id,
37                      int yr, int mth, int d,
38                      int hr = 0, int min = 0, int sec = 0);
39            CCalendar(const StdString& id, const CDate& startDate);
40            CCalendar(const StdString& id, const CDate& startDate, const CDate& timeOrigin);
41
42            CCalendar(const CCalendar& calendar);       // Not implemented yet.
43            CCalendar(const CCalendar* const calendar); // Not implemented yet.
44
45         public :
46
47            //------------------------------------------------------------
48
49            /// Autres ///
50            virtual StdString toString(void) const;
51            virtual void fromString(const StdString& str);
52
53            /// Mutateur ///
54            void setTimeStep(const CDuration& timestep);
55            void setInitDate(const CDate& initDate);
56            void setTimeOrigin(const CDate& timeOrigin);
57
58            /// Traitemants ///
59            const CDate& update(int step);
60
61            /// Accesseurs ///
62            const CDuration& getTimeStep(void) const;
63            const CDate& getInitDate(void) const;
64            const CDate& getTimeOrigin(void) const;
65            const CDate& getCurrentDate(void) const;
66
67         public :
68
69            //------------------------------------------------------------
70            virtual StdString getType(void) const;
71
72            int getStep(void) const;
73
74            virtual int getMonthLength(const CDate& date) const;
75
76            virtual int getYearTotalLength(const CDate& date) const; // Retourne la durée d'une année en seconde.
77
78            virtual int getYearLength  (void) const; // Retourne la durée d'une année en mois.
79            virtual int getDayLength   (void) const; // Retourne la durée d'un jour en heures.
80            virtual int getHourLength  (void) const; // Retourne la durée d'une heure en minute.
81            virtual int getMinuteLength(void) const; // Retourne la durée d'une minute en secondes.
82            /*! Returns the day length expressed in seconds. */
83            virtual int getDayLengthInSeconds(void) const;
84
85            virtual StdString getMonthName(int monthId) const;
86            virtual const StdString getMonthShortName(int monthId) const;
87
88            /*! Test if the calendar can have leap year. */
89            virtual bool hasLeapYear() const;
90
91            void initializeDate(int yr, int mth, int d, int hr = 0, int min = 0, int sec = 0);
92            void initializeDate(const StdString& dateStr);
93            void initializeDate(const StdString& dateStr, const StdString& timeOrigin);
94
95            /*! Simplify a duration based on the calendar information. */
96            virtual CDuration& resolve(CDuration& dur, bool noNegativeTime = false) const;
97
98            /*! Parse a date using a generic parser. */
99            static void parseDateDefault(StdIStream& in, CDate& date);
100            /*! Parse a date using the calendar's parser. */
101            virtual void parseDate(StdIStream& in, CDate& date) const;
102
103            /*! Test if a date is valid with regard to the current calendar. */
104            virtual bool checkDate(CDate& date) const;
105
106            //------------------------------------------------------------
107
108         protected:
109
110            //!< Associate the dates to the calendar and check their validity
111            void initializeDate();
112
113            //------------------------------------------------------------
114
115         private :
116            int step;
117
118            /// Propriétés privées ///
119            CDate initDate;
120            CDate timeOrigin;
121            CDate currentDate;
122            CDuration timestep;
123
124      }; // class CCalendar
125
126} // namespace xios
127
128#endif // __XIOS_CCalendar__
Note: See TracBrowser for help on using the repository browser.