TimeUnit.h

Go to the documentation of this file.

/*
 * Fimex
 *
 * (C) Copyright 2008, met.no
 *
 * Project Info:  https://wiki.met.no/fimex/start
 *
 * This library 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 library 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.
 */

#ifndef TIMEUNIT_H_
#define TIMEUNIT_H_

#include "boost/shared_ptr.hpp"
#include "fimex/Units.h"
#include "fimex/CDMException.h"
#include <iostream>
#include <boost/date_time/posix_time/posix_time_types.hpp>

namespace MetNoFimex
{

class FimexTime {
private:
    unsigned short year;
    char month;
    char mday;
    char hour;
    char minute;
    char second;
    unsigned short msecond;

public:
    enum special_values {
        min_date_time,
        max_date_time
    };
    FimexTime() {};
    FimexTime(unsigned short year, char month, char mday, char hour = 0, char minute = 0, char second = 0, unsigned short msecond = 0);
    FimexTime(special_values val);
    bool parseISO8601(const std::string& isoString);
    void setTime(unsigned short year, char month, char mday, char hour = 0, char minute = 0, char second = 0, unsigned short msecond = 0);
    unsigned short getYear() const {return year;}
    void setYear(unsigned short year) {this->year = year;}
    char getMonth() const {return month;}
    void setMonth(char month) {this->month = month;}
    char getMDay() const {return mday;}
    void setMDay(char mday) {this->mday = mday;}
    char getHour() const {return hour;}
    void setHour(char hour) {this->hour = hour;}
    char getMinute() const {return minute;}
    void setMinute(char minute) {this->minute = minute;}
    char getSecond() const {return second;}
    void setSecond(char second) {this->second = second;}
    unsigned short getMSecond() const {return msecond;}
    void setMSecond(unsigned short msecond) {this->msecond = msecond;}

    boost::posix_time::ptime asPosixTime() const;

    bool operator==(const FimexTime &rhs) const;
    bool operator!=(const FimexTime &rhs) const { return !(*this == rhs); }
    bool operator>(const FimexTime &rhs) const { return (toLong() > rhs.toLong()); }
    bool operator<(const FimexTime &rhs) const { return (rhs > *this); }
    bool operator>=(const FimexTime &rhs) const { return !(rhs > *this); }
    bool operator<=(const FimexTime &rhs) const { return !(*this > rhs); }

private:
    long long toLong() const { return year*10000000000000LL + month*100000000000LL + mday*1000000000LL + hour*10000000LL + minute*100000 + second*1000 + msecond; }
};




std::ostream& operator<< (std::ostream& out, const FimexTime& fTime);
FimexTime string2FimexTime(const std::string& str) throw(CDMException);

class TimeUnit
{
    Units units; // unit initialization
    boost::shared_ptr<void> pUnit; // pointer to unit implementation
    double epochOffset;
    double epochSlope;
public:
    TimeUnit() throw(CDMException);
    TimeUnit(const std::string& timeUnitString) throw(CDMException);
    virtual ~TimeUnit();
    double unitTime2epochSeconds(double unitTime) const;
    boost::posix_time::ptime unitTime2posixTime(double unitTime) const;
    double epochSeconds2unitTime(double epochSeconds) const;
    FimexTime unitTime2fimexTime(double unitTime) const throw(CDMException);
    double fimexTime2unitTime(const FimexTime& fiTime) const throw(CDMException);
    double fimexTime2unitTimeX(FimexTime fiTime) const throw(CDMException) { return fimexTime2unitTime(fiTime); }
    double posixTime2unitTime(boost::posix_time::ptime poTime) const throw(CDMException);
private:
    void init(const std::string& timeUnitString = "seconds since 1970-01-01 00:00:00") throw(CDMException);
};

}

#endif /* TIMEUNIT_H_ */