UTime.h

Go to the documentation of this file.

// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 4; tab-width: 4; -*-
// vim: set shiftwidth=4 softtabstop=4 expandtab:
/*
 ********************************************************************
 ** NIDAS: NCAR In-situ Data Acquistion Software
 **
 ** 2006, Copyright University Corporation for Atmospheric Research
 **
 ** 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.
 **
 ** The LICENSE.txt file accompanying this software contains
 ** a copy of the GNU General Public License. If it is not found,
 ** write to the Free Software Foundation, Inc.,
 ** 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 **
 ********************************************************************
*/
/*

    C++ class for time handling.

*/

#ifndef NIDAS_UTIL_UTIME_H
#define NIDAS_UTIL_UTIME_H

#include <sys/types.h>
#include <sys/time.h>
#include <ctime>
#include <iostream>
#include <cctype>
#include <cmath>
#include <climits>

#include <locale>
#include <string>

#include "ThreadSupport.h"
#include "ParseException.h"
#include "time_constants.h"
#include "IOException.h"

#define UTIME_BASIC_STREAM_IO

namespace nidas { namespace util {

class UTime {
public:

    UTime( );

    UTime(long long t): _utime(t),_fmt(),_utc(true) {}

    UTime(time_t t): _utime(fromSecs(t)),_fmt(),_utc(true) { }

    UTime(double t):  _utime(fromSecs(t)),_fmt(),_utc(true) { }

    UTime(bool utc,const struct tm* tmp,int usecs = 0);

    UTime(bool utc, int year,int mon, int day,int hour, int min, double sec);

    UTime(bool utc, int year,int yday,int hour, int min, double sec);

    UTime(const UTime& u) :
        _utime(u._utime),
        _fmt(u._fmt),
        _utc(u._utc)
    { }

    void setFromSecs(time_t t) { _utime = fromSecs(t); }

    struct tm* toTm(bool utc,struct tm* tmp, int* usecs = 0) const;

    struct tm* toTm(struct tm* tmp, int* usecs = 0) const;

    static long long fromTm(bool utc,const struct tm* tmp, int usecs = 0);

    bool isUTC() const { return _utc; }

    void setUTC(bool val) { _utc = val; }

    static UTime parse(bool utc, const std::string& string, int* nparsed=0)
        throw(ParseException);

    static UTime parse(bool utc, const std::string& string,
                       const std::string& format, int* nparsed=0)
        throw(ParseException);

    void set(bool utc,const std::string& string,int* nparsed=0) 
        throw(ParseException);

    void set(bool utc,const std::string& string,const std::string& format,int* nparsed=0) 
        throw(ParseException);

    std::string format(bool utc,const std::string& fmt) const;

    std::string format(const std::string& fmt) const;

    std::string format(bool utc) const;

    std::string format() const;

    UTime& operator=(const UTime& u)
    {
        if (this != &u) {
            _utime = u._utime;
            _fmt = u._fmt;
        }
        return *this;
    }

    UTime& operator=(long long u) { _utime = u; return *this; }

    UTime operator+ (long long u) const { return UTime(_utime + u); }

    UTime operator- (long long u) const { return UTime(_utime - u); }

    long long operator- (const UTime& u) const { return _utime - u._utime; }

    UTime& operator+=(long long u) { _utime += u; return *this; }

    UTime& operator-=(long long u) { _utime -= u; return *this; }

    bool operator<(const UTime& u) const { return _utime < u._utime; }

    bool operator<=(const UTime& u) const { return _utime <= u._utime; }

    bool operator>(const UTime& u) const { return _utime > u._utime; }

    bool operator>=(const UTime& u) const { return _utime >= u._utime; }

    bool operator==(const UTime& u) const { return _utime == u._utime; }

    bool operator!=(const UTime& u) const { return _utime != u._utime; }

    UTime earlier(long long y) const;

    static int month(std::string monstr);

    // conversion operator
    // operator long long() const { return _utime; }

    long long toUsecs() const
    {
    return _utime;
    } 

    double toDoubleSecs() const
    {
    // should work for positive and negative.
    return (time_t)(_utime/USECS_PER_SEC) +
        (double)(_utime % USECS_PER_SEC) / USECS_PER_SEC;
    } 

    time_t toSecs() const
    {
    return (_utime + USECS_PER_SEC / 2) / USECS_PER_SEC;
    } 

    UTime& setFormat(const std::string& val)
    {
        _fmt = val;
    return *this;
    }

    const std::string& getFormat() const
    {
        if (_fmt.length() > 0) return _fmt;
        return getDefaultFormat();
    }

    static void setDefaultFormat(const std::string& val);

    static const std::string& getDefaultFormat();

    static void setTZ(const std::string& val);

    static std::string getTZ();

    struct tm tm(bool utc) const;

#ifdef UTIME_BASIC_STREAM_IO
    template<typename charT> friend
    std::basic_ostream<charT, std::char_traits<charT> >& operator << 
        (std::basic_ostream<charT, std::char_traits<charT>  >& os,
            const UTime& x);
#else
    friend std::ostream& operator<<(std::ostream& os, const UTime &x);
#endif

    static long long pmod(long long x, long long y);

protected:

    static long long fromSecs(time_t x)
    {
        return (long long)x * USECS_PER_SEC;
    } 

    static long long fromSecs(double x)
    {
    double xf = floor(x);
        return (long long)xf * USECS_PER_SEC +
        (int)rint((x-xf) * USECS_PER_SEC) ;
    } 

    static double toDoubleSecs(long long x)
    {
    // should work for positive and negative.
    return (time_t)(x/USECS_PER_SEC) + (double)(x % USECS_PER_SEC) / USECS_PER_SEC;
    } 

    static time_t toSecs(long long x)
    {
    return x / USECS_PER_SEC;
    } 

private:

    bool
    checkParse(bool utc, const std::string& str, const std::string& fmt,
               int *ncharp, bool throwx=false);

    long long _utime;

    std::string _fmt;

    bool _utc;

    static std::string _defaultFormat;

    static Mutex _fmtMutex;

};

#ifdef UTIME_BASIC_STREAM_IO
template<typename charT>
#endif
class UTime_stream_manip {

    std::string _fmt;
#ifdef UTIME_BASIC_STREAM_IO

    std::basic_ostream<charT,std::char_traits<charT> >& (*_f)(std::basic_ostream<charT,std::char_traits<charT> >&, const std::string&);
#else
    std::ostream& (*_f)(std::ostream&, const std::string&);
#endif

public:
#ifdef UTIME_BASIC_STREAM_IO
    UTime_stream_manip(std::basic_ostream<charT,std::char_traits<charT> >&  (*f)(
        std::basic_ostream<charT,std::char_traits<charT> >&, const std::string&), const std::string& fmt): _fmt(fmt),_f(f)
    {
    }
#else
    UTime_stream_manip(std::ostream&  (*f)(
        std::ostream&, const std::string&), const std::string& fmt): _fmt(fmt),_f(f)
    {
    }
#endif

#ifdef UTIME_BASIC_STREAM_IO
    template<typename charTx>
    friend std::basic_ostream<charTx, std::char_traits<charTx> >& operator << 
        (std::basic_ostream<charTx, std::char_traits<charTx> >& os,const UTime_stream_manip<charTx>& m);
#else
    friend std::ostream& operator<<(std::ostream& os,
        const UTime_stream_manip& m);
#endif
};

#ifdef UTIME_BASIC_STREAM_IO

// format a UTime on an output stream.
template<typename charT>
std::basic_ostream<charT, std::char_traits<charT> >& operator << 
    (std::basic_ostream<charT, std::char_traits<charT> >& os,const UTime& x)
{
    return os << x.format();
}
template<typename charT>
std::basic_ostream<charT, std::char_traits<charT> >& operator <<
    (std::basic_ostream<charT, std::char_traits<charT> >& os,const UTime_stream_manip<charT>& m)
{
    return m._f(os,m._fmt);
}

// anonymous namespace for private, internal functions
namespace {
template<typename charT>
std::basic_ostream<charT, std::char_traits<charT> >& 
    setOstreamDefaultFormat(std::basic_ostream<charT, std::char_traits<charT> >& os,
        const std::string& val)
{
    UTime::setDefaultFormat(val);
    return os;
}

template<typename charT>
std::basic_ostream<charT, std::char_traits<charT> >& 
    setOstreamTZ(std::basic_ostream<charT, std::char_traits<charT> >& os,
        const std::string& val)
{
    UTime::setTZ(val);
    return os;
}
}   // end of anonymous namespace

template<typename charT>
UTime_stream_manip<charT> setDefaultFormat(const std::string& val)
{
    return UTime_stream_manip<charT>(&setOstreamDefaultFormat,val);
}

template<typename charT>
UTime_stream_manip<charT> setTZ(const std::string& val)
{
    return UTime_stream_manip<charT>(&setOstreamTZ,val);
}

#else

std::ostream& operator<<(std::ostream& os, const UTime &x)
{
    return os << x.format(false);
}

std::ostream& operator<<(std::ostream& os,
    const UTime_stream_manip& m)
{
    return m._f(os,m._fmt);
}

// anonymous namespace for private, internal functions
namespace {
std::ostream& setOstreamDefaultFormat(std::ostream& os, const std::string& val)
{
    UTime::setDefaultFormat(val);
    return os;
}

std::ostream& setOstreamTZ(std::ostream& os, const std::string& val)
{
    UTime::setTZ(val);
    return os;
}
}   // end of anonymous namespace

UTime_stream_manip setDefaultFormat(const std::string& val)
{
    return UTime_stream_manip(&setOstreamDefaultFormat,val);
}

UTime_stream_manip setTZ(const std::string& val)
{
    return UTime_stream_manip(&setOstreamTZ,val);
}

#endif

inline long long getSystemTime() {
    struct timespec ts;
    ::clock_gettime(CLOCK_REALTIME,&ts);
    return (long long)ts.tv_sec * USECS_PER_SEC + ts.tv_nsec / NSECS_PER_USEC;
}

inline long long timeCeiling(long long t,long long delta) {
    return ((t / delta) + 1) * delta;
}

inline long long timeFloor(long long t,long long delta) {
    return (t / delta) * delta;
}
extern bool sleepUntil(unsigned int periodMsec,unsigned int offsetMsec=0)
    throw(IOException);


}}  // namespace nidas namespace util

#endif