source: XIOS/trunk/src/calendar.hpp @ 549

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

Revised calendar functionalities:

  • the calendar is now configured from a specific calendar child node of the context in the XML configuration file. Example: <calendar type="Gregorian" start_date="2012-03-01 15:00:00" time_origin="2012-02-29 15:00:00" timestep="1h" />
  • the calendar type should now be configured when defining the start time and/or the time origin.
  • the start time and the time origin are now optional, 0000-01-01 00:00:00 will be used by default. It is also possible to define them partially. For example, 2015 and 2014-12 are valid dates corresponding respectively to 2015-01-01 00:00:00 and 2014-12-01 00:00:00.
  • an optional duration offset can be added to the start date and time origin. For example, it's possible to define the date 2015-01-12 12:00:00 as 2015-01-11 + 36h or 2015-01-11 12:00:00 + 1d. The duration format is the same as the time step. Being that the date is optional, it is possible to only use a duration (for example + 42s is the same as 0000-01-01 00:00:00 + 42s). An error will be raised if a duration based on the time step is used before the time step was configured. For example, the following would cause an error: <calendar type="Gregorian" start_date="+ 1ts" /> but <calendar type="Gregorian" start_date="+ 1ts" timestep="0.5h" /> would not.
  • new Fortran interface to define the calendar:
    • xios_define_calendar(type[, timestep, start_date, time_origin]) will create a calendar when none had previously been defined. Only the type argument is mandatory, the rest is optional. Calendar operations on dates and durations are possible as soon as the calendar is created (either using this procedure or directly from the XML configuration file).
    • the following getter and setter procedures are available: xios_set_timestep, xios_set_start_date, xios_set_time_origin, xios_get_calendar_type, xios_get_timestep, xios_get_start_date, xios_get_time_origin.
  • new Fortran interface to interact with the calendar: xios_update_calendar, xios_get_current_date, xios_get_year_length_in_seconds, xios_get_day_length_in_seconds.
  • new Fortran interface for date conversion: xios_date_get_second_of_year, xios_date_get_day_of_year, xios_date_get_fraction_of_year, xios_date_get_second_of_day, xios_date_get_fraction_of_day.
  • two new placeholders are available to format the file name when splitting the output (split_freq_format attribute):
    • %S the number of seconds since the time origin
    • %D the integral number of days since the time origin
  • 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: 3.7 KB
Line 
1#ifndef __XMLIO_CCalendar__
2#define __XMLIO_CCalendar__
3
4/// xios headers ///
5#include "xmlioserver_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            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            CDate& getCurrentDate(void);
66
67         public :
68
69            //------------------------------------------------------------
70            virtual int getMonthLength(const CDate& date) const;
71
72            virtual StdString getType(void) const;
73
74            virtual int getYearTotalLength(const CDate& date) const; // Retourne la durée d'une année en seconde.
75
76            virtual int getYearLength  (void) const; // Retourne la durée d'une année en mois.
77            virtual int getDayLength   (void) const; // Retourne la durée d'un jour en heures.
78            virtual int getHourLength  (void) const; // Retourne la durée d'une heure en minute.
79            virtual int getMinuteLength(void) const; // Retourne la durée d'une minute en secondes.
80            //!< Returns the day length expressed in seconds
81            virtual int getDayLengthInSeconds(void) const;
82
83            virtual StdString getMonthName(int month_id) const;
84
85            virtual const StdString getMonthShortName(int month_id) const;
86            void initializeDate(int yr, int mth, int d, int hr = 0, int min = 0, int sec = 0);
87            void initializeDate(const StdString& dateStr);
88            void initializeDate(const StdString& dateStr, const StdString& timeOrigin);
89
90            //------------------------------------------------------------
91
92         protected:
93
94            //!< Associate the dates to the calendar and check their validity
95            void initializeDate();
96
97            //------------------------------------------------------------
98
99         private :
100
101            /// Propriétés privées ///
102            CDate initDate;
103            CDate timeOrigin;
104            CDate currentDate;
105            CDuration timestep;
106
107      }; // class CCalendar
108
109} // namespace xios
110
111#endif // __XMLIO_CCalendar__
Note: See TracBrowser for help on using the repository browser.