core/DateTime.hpp

Go to the documentation of this file.

/*
  This file is part of OpenFLUID software
  Copyright (c) 2007-2010 INRA-Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID 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 3 of the License, or
  (at your option) any later version.

  OpenFLUID 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 OpenFLUID.  If not, see <http://www.gnu.org/licenses/>.

  In addition, as a special exception, INRA gives You the additional right
  to dynamically link the code of OpenFLUID with code not covered
  under the GNU General Public License ("Non-GPL Code") and to distribute
  linked combinations including the two, subject to the limitations in this
  paragraph. Non-GPL Code permitted under this exception must only link to
  the code of OpenFLUID dynamically through the OpenFLUID libraries
  interfaces, and only for building OpenFLUID plugins. The files of
  Non-GPL Code may be link to the OpenFLUID libraries without causing the
  resulting work to be covered by the GNU General Public License. You must
  obey the GNU General Public License in all respects for all of the
  OpenFLUID code and other code used in conjunction with OpenFLUID
  except the Non-GPL Code covered by this exception. If you modify
  this OpenFLUID, you may extend this exception to your version of the file,
  but you are not obligated to do so. If you do not wish to provide this
  exception without modification, you must delete this exception statement
  from your version and license this OpenFLUID solely under the GPL without
  exception.


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
*/


#ifndef __DATETIME_HPP__
#define __DATETIME_HPP__


#include <sys/types.h>
#include <time.h>
#include <string>

#include <openfluid/dllexport.hpp>


namespace openfluid { namespace core {

typedef unsigned long long rawtime_t;

class DLLEXPORT DateTime
{
  private:

    struct tm m_TM;

    rawtime_t m_RawTime;

    void updateYMDHMSFromRawTime();

    void updateRawTimeFromYMDHMS();


  public:

    DateTime();

    DateTime(int Year, int Month, int Day, int Hour, int Minute, int Second);

    DateTime(rawtime_t SecondsSince0000);

    ~DateTime();

    bool set(int Year, int Month, int Day, int Hour, int Minute, int Second);

    void set(const rawtime_t& SecondsSince0000);


    bool setFromISOString(const std::string& DateTimeStr);


    int getYear() const {return (m_TM.tm_year+1900); };

    int getMonth() const {return (m_TM.tm_mon+1) ;};

    int getDay() const {return m_TM.tm_mday;};

    int getHour() const {return m_TM.tm_hour;};

    int getMinute() const {return m_TM.tm_min;};

    int getSecond() const {return m_TM.tm_sec;};

    rawtime_t getRawTime() const;


    std::string getAsISOString() const;

    std::string getAsString(std::string Format) const;


    std::string getDateAsISOString() const;

    std::string getTimeAsISOString() const;


    void addSeconds(const rawtime_t& Seconds);

    void subtractSeconds(const rawtime_t& Seconds);

    rawtime_t diffInSeconds(const DateTime& DT) const;

    bool isBetween(const DateTime& FirstDT, const DateTime& SecondDT);

    bool isStrictlyBetween(const DateTime& FirstDT, const DateTime& SecondDT);


    DateTime& operator =(const DateTime &Right);

    bool operator ==(const DateTime &Right) const;

    bool operator !=(const DateTime &Right) const;

    bool operator >(const DateTime &Right) const;

    bool operator >=(const DateTime &Right) const;

    bool operator <(const DateTime &Right) const;

    bool operator <=(const DateTime &Right) const;

    DateTime operator +(const rawtime_t& Seconds) const;

    DateTime operator -(const rawtime_t& Seconds) const;

    static inline rawtime_t Minute() { return 60; };

    static inline rawtime_t Minutes(int N) { return (60*N); };

    static inline rawtime_t Hour() { return 3600; };

    static inline rawtime_t Hours(int N) { return (3600*N); };

    static inline rawtime_t Day() { return 86400; };

    static inline rawtime_t Days(int N) { return (86400*N); };

    static inline rawtime_t Week() { return 604800; };

    static inline rawtime_t Weeks(int N) { return (604800*N); };

    static bool isLeapYear(int Year);

    static int getNumOfDaysInMonth(int Year, int Month);

    static bool isValidDateTime(int Year, int Month, int Day, int Hour, int Minute, int Second);

    bool isSameDate(const DateTime& DT) const;

    bool isSameTime(const DateTime& DT) const;

};



} } // namespaces

#endif