Changeset 549 for XIOS/trunk/src/date.hpp

Timestamp:

01/26/15 14:39:26 (9 years ago)

Author:

rlacroix

Message:

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

File:

• XIOS/trunk/src/date.hpp (modified) (4 diffs)

XIOS/trunk/src/date.hpp

@@ -20 +20 @@
             CDate(void);
             //!< Create an empty date associated to the specified calendar
-            CDate(const CCalendar & cal);
+            CDate(const CCalendar& cal);
             //!< Create a date associated to the specified calendar
-            CDate(const CCalendar & cal, int yr, int mth, int d,
-                                         int hr = 0, int min = 0, int sec = 0);
-            CDate(const CDate & odate);
-            CDate(const CDate * const odate); // Not implemented yet
+            CDate(const CCalendar& cal, int yr, int mth, int d,
+                                        int hr = 0, int min = 0, int sec = 0);
+            CDate(const CDate& odate);
+            CDate(const CDate* const odate); // Not implemented yet
 
             /// Destructeur ///
@@ -31 +31 @@
 
             /// Opérateurs ///
-            CDate & operator=(const CDate & date);
-            friend StdOStream & operator<<(StdOStream & out, const CDate & date);
-            friend StdIStream & operator>>(StdIStream & in, CDate & date); // Non testée.
+            CDate& operator=(const CDate& date);
+            friend StdOStream& operator<<(StdOStream& out, const CDate& date);
+            friend StdIStream& operator>>(StdIStream& in, CDate& date); // Non testée.
 
             //!< Return the number of seconds since the time origin fixed when creating the calendar
@@ -52 +52 @@
             const CCalendar& getRelCalendar(void) const;
             bool hasRelCalendar(void) const;
+
+            //!< Get the number of seconds since the beginning of the year
+            int getSecondOfYear() const;
+            //!< Get the number of days (expressed as a real number) since the beginning of the year
+            double getDayOfYear() const;
+            //!< Get the fraction of the current year as a real number between 0 and 1
+            double getFractionOfYear() const;
+            //!< Get the number of seconds since the beginning of the day
+            int getSecondOfDay() const;
+            //!< Get the fraction of the current day as a real number between 0 and 1
+            double getFractionOfDay() const;
 
             /// Mutateurs ///
@@ -77 +88 @@
          public : /* static */
 
-            static CDate FromString(const StdString & str, const CCalendar & calendar);
+            static CDate FromString(const StdString& str, const CCalendar& calendar);
 
          private :