source: XIOS/dev/dev_trunk_omp/src/calendar.hpp @ 1629

Last change on this file since 1629 was 1629, checked in by yushan, 3 years ago

inlining calendar fonctions

  • 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: 5.4 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 { return this->timestep; };
63            const CDate& getInitDate(void) const { return this->initDate; };
64            const CDate& getTimeOrigin(void) const { return this->timeOrigin; };
65            const CDate& getCurrentDate(void) const { return this->currentDate; };
66
67         public :
68
69            //------------------------------------------------------------
70            virtual StdString getType(void) const;
71
72            int getStep(void) const {return step;};
73
74            inline int getMonthLength(const CDate& date) const
75            {
76              static const int NoLeapMonthLength[] = { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 };
77              return NoLeapMonthLength[date.getMonth() - 1];
78            };
79
80            //virtual int getYearTotalLength(const CDate& date) const; // Retourne la durée d'une année en seconde.
81            inline virtual int getYearTotalLength(const CDate& date) const { return (365 * 86400); } ; // Retourne la durée d'une année en seconde.
82
83            //virtual int getYearLength  (void) const; // Retourne la durée d'une année en mois.
84            inline virtual int getYearLength (void) const { return 12; } ;
85            inline virtual int getDayLength   (void) const { return 24; } ; // Retourne la durée d'un jour en heures.
86            inline virtual int getHourLength  (void) const { return 60; } ; // Retourne la durée d'une heure en minute.
87            inline virtual int getMinuteLength(void) const {return 60; } ; // Retourne la durée d'une minute en secondes.
88            /*! Returns the day length expressed in seconds. */
89            inline virtual int getDayLengthInSeconds(void) const { return 86400; } ;
90
91            inline virtual StdString getMonthName(int monthId) const
92            {
93              static const StdString MonthNames[] =
94                         { "january", "february", "march",     "april" ,  "may",      "june",
95                           "july",    "august",   "september", "october", "november", "december" };
96              return MonthNames[monthId - 1];
97            };
98            virtual const StdString getMonthShortName(int monthId) const;
99
100            /*! Test if the calendar can have leap year. */
101            inline virtual bool hasLeapYear() const {return false;};
102
103            void initializeDate(int yr, int mth, int d, int hr = 0, int min = 0, int sec = 0);
104            void initializeDate(const StdString& dateStr);
105            void initializeDate(const StdString& dateStr, const StdString& timeOrigin);
106
107            /*! Simplify a duration based on the calendar information. */
108            virtual CDuration& resolve(CDuration& dur, bool noNegativeTime = false) const;
109
110            /*! Parse a date using a generic parser. */
111            static void parseDateDefault(StdIStream& in, CDate& date);
112            /*! Parse a date using the calendar's parser. */
113            virtual void parseDate(StdIStream& in, CDate& date) const;
114
115            /*! Test if a date is valid with regard to the current calendar. */
116            virtual bool checkDate(CDate& date) const;
117
118            //------------------------------------------------------------
119
120         protected:
121
122            //!< Associate the dates to the calendar and check their validity
123            void initializeDate();
124
125            //------------------------------------------------------------
126
127         private :
128            int step;
129
130            /// Propriétés privées ///
131            CDate initDate;
132            CDate timeOrigin;
133            CDate currentDate;
134            CDuration timestep;
135
136      }; // class CCalendar
137
138} // namespace xios
139
140#endif // __XIOS_CCalendar__
Note: See TracBrowser for help on using the repository browser.