/home/pascal/depot/filedata/src/date.h

/***************************************************************************
 *   Copyright (C) 2005 by Nicolas PASCAL                                  *
 *   nicolas.pascal@icare.univ-lille1.fr                                   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

/**************************************************************************
*  History :                                                              *
*  3/08/05 : start                                                        *
**************************************************************************/

#ifndef DATE_H
#define DATE_H

#define DATE_TEST 0

#include <iostream>
#include <string>
#include <assert.h>
#include <cmath>
#include <ctime>
#include <clocale>
#include <exception>

#include "tools.h"

using namespace std;

static const int MAX_FORMATTED_STRING_SIZE=128;

class bad_date : public exception {
public:
    bad_date() {}
    ;
    ~bad_date() throw() {
        ;
    };
    virtual const char* what() const throw() {
        string m="bad_date : Sorry, the date you tried to entered is invalid";
        return m.c_str();
    };
};
class bad_month : public exception {
    int month;
public:
    bad_month(const int month) : month(month){};
    ~bad_month() throw() {};
    virtual const char* what() const throw() {
        string m="bad_month : it must be in range [1,12], and you entered "+MyTools::to_string(month);
        return m.c_str();
    };
};

class parse_date_error : public std::exception {
public:
    parse_date_error(const string &date, const string &format):date(date),format(format) {};
    ~parse_date_error() throw() {}
    ;
    virtual const char* what() const throw() {
      std::ostringstream oss;
      oss<<"parse_date_error : can't parse the date "<<date<<" using the format "<<format<<std::endl;
      return oss.str().c_str();
    };
private:
    string date;
    string format;
};

class Epoch2Leap {
    double epoch_time;
    int   leap_sec;
public:
    Epoch2Leap ( const double epoch_time = 0., const int leap_sec = 0 ) : epoch_time(epoch_time), leap_sec (leap_sec){};

    ~Epoch2Leap () {};

    double get_epoch_time() const {
        return epoch_time;
    }
    int get_leap_sec() const {
        return leap_sec;
    }
    void print () const {
        cout << epoch_time << " -> " << leap_sec <<  endl;
    }
};

class Date {
    time_t epoch_time;
    /* Table of the leap seconds between TAI and UTC from the 1st of January 1972 at 00:00:00
     each line is :
     ( <start of range, included>, <end of range, excluded>, TAI - UTC leap seconds  )
     source : ftp://hpiers.obspm.fr/iers/bul/bulc/UTC-TAI.history */
    static vector < Epoch2Leap > utc_2_tai_leap_sec;
public:
    // constant number of leap seconds between the TAI93 start ( 1st of January 1993 at 00:00:00 ) and the UTC start ()
    static const int nsec_tai93_to_utc_start = 27;
    Date(int year = 1970, int month = 1, int day = 1, int hour = 0, int min = 0, int sec = 0);
    Date(const time_t& tm);
    Date( const double & tm );
    ~Date() {}
    ;
    static void init_leap_sec_table ();
    static double get_tai93_leap_sec ( const Date &d );
    static double get_tai_leap_sec ( const Date &d );
    Date &operator= (const Date &d);
    Date operator+ (const double &time);
    bool operator== (const Date &d) const;
    bool operator!= (const Date &d) const;
    bool operator<= (const Date &d) const;
    bool operator>= (const Date &d) const;
    bool operator< (const Date &d) const;
    bool operator> (const Date &d) const;
    bool is_epoch_start( ) const {return epoch_time==0.;};
    const int get_sec() const;
    const int get_min() const;
    const int get_hour() const;
    const int get_day() const;
    const int get_month() const;
    const int get_year() const;
    const int get_yday() const;
    static const vector<Date> get_days(const Date &start, const Date &end);
    static const int get_nb_day(const int &month,const int &year);
    static int get_day_number(const int &year,const int &month, int &day);
    static void get_day_range(const int &year,const int &month, int &first, int &last);
    static const string get_month_string( const int _month );
    const bool is_the_same_day(const Date &d);
    void set_julian_time(const double &julian_time);
    const double get_julian_time();
    const double get_TAI93_time() const ;
    void set_TAI93_time(const double &TAI_time);
    const double get_ECMWF_time() const ;
    void set_ECMWF_time(const double &time);

    void set_date(const int &_year = 1970, const int& _month = 1, const int& _day = 1, const int& _hour = 0, const int& _min = 0, const int& _sec = 0);
    void set_date_str(const string &s = "", const char * _format = "");
    const string get_date_str(const char * _format = "");
    void set_epoch_time(const time_t& _epoch_time);
    time_t get_epoch_time() const {
        return epoch_time;
    }
    void print() const;
    string to_string() const;

    static time_t get_epoch_time ( const char* s_date, const char * format );

    friend std::ostream &operator<< (std::ostream &stream, const Date &date);
};

#endif