DODS_Time.h

 
// -*- 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)
 
#ifndef _dods_time_h
#define _dods_time_h
 
 
#include <string>
 
#include <libdap/dods-datatypes.h>
#include <libdap/BaseType.h>
 
using namespace libdap ;

 
class DODS_Time {
private:
    dods_uint32 _hours;     // 0--23; regular wall time
    dods_uint32 _minutes;   // 0--59
    double _seconds;        // 0--59.9...
    double _sec_since_midnight;
    bool _gmt;
 
    static double _eps;     // defined as 1.0e-6 in DODS_Time.cc
 
protected:
 
public:


    DODS_Time(string time);

    DODS_Time(BaseType *arg);

    DODS_Time(dods_uint32 hh, dods_uint32 mm, bool gmt = false);

    DODS_Time(dods_uint32 hh, dods_uint32 mm, double ss, bool gmt = false);

    DODS_Time();



    void set(string time);

    void set(BaseType *arg);

    void set(int hh, int mm, bool gmt = false);

    void set(int hh, int mm, double ss, bool gmt = false);



    string get(bool gmt = true) const;

    int hours() const;

    int minutes() const;

    double seconds() const;

    bool gmt() const;

    double seconds_since_midnight() const;

    double fraction() const;


    friend int operator==(DODS_Time &t1, DODS_Time &t2);

    friend int operator!=(DODS_Time &t1, DODS_Time &t2);

    friend int operator<(DODS_Time &t1, DODS_Time &t2);

    friend int operator>(DODS_Time &t1, DODS_Time &t2);

    friend int operator<=(DODS_Time &t1, DODS_Time &t2);

    friend int operator>=(DODS_Time &t1, DODS_Time &t2);

    bool OK() const;

    double get_epsilon() const;

    void set_epsilon(double eps);
 
};
 
// $Log: DODS_Time.h,v $
// Revision 1.7  2003/02/10 23:01:52  jimg
// Merged with 3.2.5
//
// Revision 1.6.2.1  2002/01/22 02:19:35  jimg
// Fixed bug 62. Users built fmt files that used types other than int32
// for date and time components (e.g. int16). I fixed the factory classes
// so that DODS_Date and DODS_Time objects will be built correctly when
// any of the integer (or in the case of seconds, float) data types are
// used. In so doing I also refactored the factory classes so that code
// duplication was reduced (by using inhertiance).
// Added two tests for the new capabilities (see date_time.1.exp, the last
// two tests).
//
// Revision 1.6  2000/10/11 19:37:55  jimg
// Moved the CVS log entries to the end of files.
// Changed the definition of the read method to match the dap library.
// Added exception handling.
// Added exceptions to the read methods.
//
// Revision 1.5  1999/07/22 21:28:09  jimg
// Merged changes from the release-3-0-2 branch
//
// Revision 1.4.6.1  1999/06/01 15:38:06  jimg
// Added code to parse and return floating point dates.
//
// Revision 1.4  1999/05/04 02:55:35  jimg
// Merge with no-gnu
//
// Revision 1.3.6.1  1999/05/01 04:40:30  brent
// converted old String.h to the new std C++ <string> code
//
// Revision 1.3  1999/01/08 22:08:19  jimg
// Fixed doc++ comments.
//
// Revision 1.2  1999/01/05 00:37:28  jimg
// Removed string class; replaced with the GNU String class. It seems those
// don't mix well.
// Switched to simpler method names.
// Added DOC++ Comments.
//
// Revision 1.1  1998/12/28 19:07:33  jimg
// Initial version of the DODS_Time object
//
 
#endif // _dods_time_h