DateTime.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* The Base of this class has been adopted from the Delta3D engine
*
* 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 3.0 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.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Class Inspired by the Delta3D Engine
* http://delta3dengine.org/
*
* @author Bradley Anderegg
*/
#pragma once

#include "Export.h"

#include <trUtil/EnumerationString.h>

namespace trUtil
{
    class TR_UTIL_EXPORT DateTime
    {
    public:

        class TR_UTIL_EXPORT TimeOrigin : public trUtil::EnumerationString
        {
            DECLARE_ENUM(TimeOrigin)

        public:
            static const TimeOrigin LOCAL_TIME;
            static const TimeOrigin GMT_TIME;

        protected:

            /*virtual*/ ~TimeOrigin(){}

        private:

            TimeOrigin(const std::string& name) : trUtil::EnumerationString(name)
            {
                AddInstance(this);
            }
        };

        class TR_UTIL_EXPORT TimeType : public trUtil::EnumerationString
        {
            DECLARE_ENUM(TimeType)

        public:
            static const TimeType CLOCK_TIME;
            static const TimeType SIMULATION_TIME;
            static const TimeType SCENARIO_TIME;
            static const TimeType TRIP_TIME;
            static const TimeType TIME_STAMP;
            static const TimeType TIME_TYPE_OTHER;

        protected:

            /*virtual*/ ~TimeType(){}

        private:

            TimeType(const std::string& name) : trUtil::EnumerationString(name)
            {
                AddInstance(this);
            }
        };

        class TR_UTIL_EXPORT TimeFormat : public trUtil::EnumerationString
        {
            DECLARE_ENUM(TimeFormat)

        public:

            static const TimeFormat LOCAL_DATE_AND_TIME_FORMAT;

            static const TimeFormat LOCAL_DATE_FORMAT;

            static const TimeFormat CLOCK_TIME_12_HOUR_FORMAT;

            static const TimeFormat CLOCK_TIME_24_HOUR_FORMAT;

            static const TimeFormat LEXICAL_DATE_FORMAT;

            static const TimeFormat CALENDAR_DATE_FORMAT;

            static const TimeFormat ORDINAL_DATE_FORMAT;

            static const TimeFormat WEEK_DATE_FORMAT;

            static const TimeFormat CALENDAR_DATE_AND_TIME_FORMAT;

        protected:

            /*virtual*/ ~TimeFormat(){}

        private:

            TimeFormat(const std::string& name) : trUtil::EnumerationString(name)
            {
                AddInstance(this);
            }
        };

    public:

        DateTime();

        DateTime(const TimeOrigin& initAs);

        DateTime(time_t);

        DateTime(const struct tm&);

        DateTime(const DateTime&);

        DateTime& operator=(const DateTime&);

        virtual ~DateTime();

        static float GetLocalGMTOffset(bool accountForDST = false);

        void SetToLocalTime();

        void SetToGMTTime();

        void IncrementClock(double seconds);

        void AdjustTimeZone(float newGMTOffset);

        void GetTime(unsigned& year, unsigned& month, unsigned& day, unsigned& hour, unsigned& min, float& sec) const;

        void GetTime(unsigned& year, unsigned& month, unsigned& day, unsigned& hour, unsigned& min, unsigned& sec) const;

        void GetGMTTime(unsigned& year, unsigned& month, unsigned& day, unsigned& hour, unsigned& min, float& sec) const;

        void GetGMTTime(unsigned& year, unsigned& month, unsigned& day, unsigned& hour, unsigned& min, unsigned& sec) const;

        void SetTime(unsigned year, unsigned month, unsigned day, unsigned hour, unsigned min, float sec);

        void SetTime(unsigned year, unsigned month, unsigned day, unsigned hour, unsigned min, unsigned sec);

        time_t GetTime() const;

        time_t GetGMTTime() const;

        void SetTime(time_t);

        double GetTimeInSeconds() const;

        void GetTime(tm&) const;

        void GetGMTTime(tm&) const;

        void SetTime(const tm&);

        void SetGMTOffset(float hourOffset, bool dayLightSavings);

        static float CalcGMTOffset(tm& timeParts, bool factorLocalDayLightSavingsIntoGMTOffset);

        void SetGMTOffset(double lattitude, double longitude, bool dayLightSavings);

        float GetGMTOffset() const;

        float GetTimeScale() const;

        void SetTimeScale(float percentScaleInSeconds);

        const TimeType& GetTimeType() const;

        void SetTimeType(const TimeType&);

        const TimeOrigin& GetTimeOrigin() const;

        void SetTimeOrigin(const TimeOrigin&);

        const TimeFormat& GetTimeFormat() const;

        void SetTimeFormat(const TimeFormat&);

        float GetSecond() const;

        void SetSecond(float sec);

        unsigned GetMinute() const;

        void SetMinute(unsigned min);

        unsigned GetHour() const;

        void SetHour(unsigned hour);

        unsigned GetDay() const;

        void SetDay(unsigned day);

        unsigned GetMonth() const;

        void SetMonth(unsigned month);

        unsigned GetYear() const;

        void SetYear(unsigned year);

        std::string ToString() const;

        std::string ToString(const TimeFormat&) const;

        static std::string ToString(const DateTime&, const TimeFormat&);

        operator time_t() const;

        operator tm() const;

        operator std::string() const;

        //TODO- add operators
        //DateTime& operator +=(const DateTime&);
        //DateTime& operator -=(const DateTime&);

        //bool operator<(const DateTime&) const;
        //bool operator>(const DateTime&) const;

        //std::ostream& operator >>(std::ostream&);

    private:

        void ResetToDefaultValues();

        static void GetGMTTime(time_t* t, tm& timeParts);

        static void GetLocalTime(time_t* t, tm& timeParts);


        float mGMTOffset;
        float mTimeScale;
        double mFractionalSeconds;

        unsigned mSeconds, mMinutes, mHours, mDays, mMonths, mYears;

        const TimeOrigin* mTimeOrigin;
        const TimeType* mTimeType;
        const TimeFormat* mStringFormat;
    };
}