Changeset 549 for XIOS/trunk/src/calendar.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/calendar.hpp (modified) (3 diffs)

XIOS/trunk/src/calendar.hpp

@@ -33 +33 @@
             /// Constructeurs ///
             CCalendar(void);
-            CCalendar(const StdString& id) ;
+            CCalendar(const StdString& id);
             CCalendar(const StdString& id,
                       int yr, int mth, int d,
@@ -49 +49 @@
             /// Autres ///
             virtual StdString toString(void) const;
-            virtual void fromString(const StdString & str);
+            virtual void fromString(const StdString& str);
 
             /// Mutateur ///
-            void setTimeStep(const CDuration & duration);
+            void setTimeStep(const CDuration& timestep);
+            void setInitDate(const CDate& initDate);
+            void setTimeOrigin(const CDate& timeOrigin);
 
             /// Traitemants ///
-            CDate & update(int step);
+            CDate& update(int step);
 
             /// Accesseurs ///
-            const CDuration & getTimeStep(void) const;
-            const CDate & getInitDate(void) const;
-            const CDate & getTimeOrigin(void) const;
-             CDate & getCurrentDate(void);
-            
+            const CDuration& getTimeStep(void) const;
+            const CDate& getInitDate(void) const;
+            const CDate& getTimeOrigin(void) const;
+            CDate& getCurrentDate(void);
+
          public :
-         
+
             //------------------------------------------------------------
-            virtual int getMonthLength(const CDate & date) const ;
+            virtual int getMonthLength(const CDate& date) const;
 
             virtual StdString getType(void) const;
 
-            virtual int getYearTotalLength(const CDate & date) const ; // Retourne la durée d'une année en seconde.
+            virtual int getYearTotalLength(const CDate& date) const; // Retourne la durée d'une année en seconde.
 
             virtual int getYearLength  (void) const; // Retourne la durée d'une année en mois.
@@ -76 +78 @@
             virtual int getHourLength  (void) const; // Retourne la durée d'une heure en minute.
             virtual int getMinuteLength(void) const; // Retourne la durée d'une minute en secondes.
+            //!< Returns the day length expressed in seconds
+            virtual int getDayLengthInSeconds(void) const;
 
-            virtual int getNbSecond(const CDate & date) const;
             virtual StdString getMonthName(int month_id) const;
 
             virtual const StdString getMonthShortName(int month_id) const;
-            void initializeDate(int yr, int mth, int d, int hr = 0, int min = 0, int sec = 0) ;
-            void initializeDate(const StdString & dateStr);
-            void initializeDate(const StdString & dateStr, const StdString & timeOrigin);
+            void initializeDate(int yr, int mth, int d, int hr = 0, int min = 0, int sec = 0);
+            void initializeDate(const StdString& dateStr);
+            void initializeDate(const StdString& dateStr, const StdString& timeOrigin);
 
             //------------------------------------------------------------
 
          protected:
-            
+
             //!< Associate the dates to the calendar and check their validity
             void initializeDate();