DODS_Date.h

Go to the documentation of this file.

// -*- mode: c++; c-basic-offset:4 -*-

// This file is part of ff_handler a FreeForm API handler for the OPeNDAP
// DAP2 data server.

// Copyright (c) 2005 OPeNDAP, Inc.
// Author: James Gallagher <jgallagher@opendap.org>
//
// This is free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation; either version 2.1 of the License, or (at your
// option) any later version.
// 
// This software 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 Lesser General Public
// License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.


// (c) COPYRIGHT URI/MIT 1998
// Please read the full copyright statement in the file COPYRIGHT.  
//
// Authors:
//      jhrg,jimg       James Gallagher (jgallagher@gso.uri.edu)

// $Log: DODS_Date.h,v $
// Revision 1.8  2001/09/28 23:19:43  jimg
// Merged with 3.2.3.
//
// Revision 1.7.2.1  2001/05/23 18:25:49  dan
// Modified to support year/month date representations,
// and to support ISO8601 output formats.
//
// Revision 1.6  1999/07/22 21:28:08  jimg
// Merged changes from the release-3-0-2 branch
//
// Revision 1.5.6.1  1999/06/01 15:38:06  jimg
// Added code to parse and return floating point dates.
//
// Revision 1.5  1999/05/04 02:55:35  jimg
// Merge with no-gnu
//
// Revision 1.4.6.1  1999/05/01 04:40:30  brent
// converted old String.h to the new std C++ <string> code
//
// Revision 1.4  1999/01/08 22:08:18  jimg
// Fixed doc++ comments.
//
// Revision 1.3  1999/01/05 00:34:45  jimg
// Removed string class; replaced with the GNU String class. It seems those
// don't mix well.
// Switched to simpler method names.
// Added the date_format enumerated type.
//
// Revision 1.2  1998/12/30 02:01:12  jimg
// Added class invariant.
//
// Revision 1.1  1998/12/28 19:08:26  jimg
// Initial version of the DODS_Date object
//

#ifndef _dods_date_h
#define _dods_date_h


#include <time.h>

#include <string>

#include "BaseType.h"
#include "date_proc.h"

using namespace libdap ;

const double seconds_per_day = 86400.0;
const double seconds_per_hour = 3600.0;
const double seconds_per_minute = 60.0;

enum date_format {
    unknown_format,
    ymd,
    yd,
    ym,
    decimal,
    iso8601
};

class DODS_Date {
private:
    long _julian_day;
    int _year;
    int _month;
    int _day;
    int _day_number;
    date_format _format;

    void parse_fractional_time(string date);
    void parse_integer_time(string date);
    void parse_iso8601_time(string date);

public:
    DODS_Date();
    
    DODS_Date(string date_str);

    DODS_Date(BaseType *arg);

    DODS_Date(int year, int day_num);

    DODS_Date(int year, int month, int day);
    DODS_Date(int year, int month, int day, date_format format);

    void set(string date);

    void set(BaseType *arg);

    void set(int year, int day_number);

    void set(int year, int month, int day);

    void set(int year, int month, int day, date_format format);


    string get(date_format format = ymd) const;

    int year() const;

    int month() const;

    int day() const;

    int day_number() const;

    long julian_day() const;

    date_format format() const;

    time_t unix_time() const;

    /* Get the date as a real number. The year is the whole number and days
       are as fractions of a year. E.G.: 1998.5 is approximately June, 1998.

       @return The date (year, month and day) as a real number. */
    double fraction() const;

    friend int operator==(DODS_Date &d1, DODS_Date &d2);

    friend int operator!=(DODS_Date &d1, DODS_Date &d2);

    friend int operator<(DODS_Date &d1, DODS_Date &d2);

    friend int operator>(DODS_Date &d1, DODS_Date &d2);

    friend int operator<=(DODS_Date &d1, DODS_Date &d2);

    friend int operator>=(DODS_Date &d1, DODS_Date &d2);

    bool OK() const;
};

#endif // _dods_date_h