ufoai/html/_date_time_8h_source.html

/*

Copyright (C) 2002-2025 UFO: Alien Invasion.


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.


You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/


#pragma once


class DateTime

{

    public:

        /* basic time constants */

        static const short SECONDS_PER_MINUTE = 60;

        static const short MINUTES_PER_HOUR = 60;

        static const short HOURS_PER_DAY = 24;

        static const int DAYS_PER_YEAR = 365;

        static constexpr float DAYS_PER_YEAR_AVG = 365.25f;

        static const short MONTHS_PER_YEAR = 12;

        static const short SEASONS_PER_YEAR = 4;

        /* computed time constants*/

        static const short SECONDS_PER_HOUR = SECONDS_PER_MINUTE * MINUTES_PER_HOUR;

        static const int SECONDS_PER_DAY = HOURS_PER_DAY * SECONDS_PER_HOUR;


        /* constructors */

        DateTime(int day = 0, int second = 0);


        /* public methods */

        int getDateAsDays() const;

        int getTimeAsSeconds() const;


        /* operators */

        DateTime& operator+=(const DateTime& other);

        DateTime operator+(const DateTime& other) const;

        DateTime& operator-=(const DateTime& other);

        DateTime operator-(const DateTime& other) const;


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

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

        bool operator<(const DateTime& other) const;

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

        bool operator>(const DateTime& other) const;

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


    protected:

        /* internal data */

        int day;

        int second;


        /* private methods */

        void reCalculate(void);

#if 0

        /* public methods */

        void getDateParts(int* year, short* month, short* day, short* hour, short* minute, short* second) const;

        int getYear(void) const;

        int getMonth(void) const;

        int getDay(void) const;

        int getHour(void) const;

        int getMinute(void) const;

        int getSecond(void) const;


        const char* asString(const char* format) const;

#endif

};


DateTime::operator<
bool operator<(const DateTime &other) const
Decides if the left DateTime is earlier than the right one.
Definition DateTime.cpp:126

DateTime::operator+=
DateTime & operator+=(const DateTime &other)
Adds a DateTime (duration) to the left DateTime object.
Definition DateTime.cpp:66

DateTime::operator>=
bool operator>=(const DateTime &other) const
Decides if the left DateTime is later or equal to the right one.
Definition DateTime.cpp:150

DateTime::HOURS_PER_DAY
static const short HOURS_PER_DAY
Definition DateTime.h:36

DateTime::second
int second
Definition DateTime.h:68

DateTime::SEASONS_PER_YEAR
static const short SEASONS_PER_YEAR
Definition DateTime.h:40

DateTime::DateTime
DateTime(int day=0, int second=0)
Construct for DateTime class from date as days and time as seconds.
Definition DateTime.cpp:34

DateTime::SECONDS_PER_DAY
static const int SECONDS_PER_DAY
Definition DateTime.h:43

DateTime::getTimeAsSeconds
int getTimeAsSeconds() const
Return the time part of the DateTime as seconds.
Definition DateTime.cpp:54

DateTime::operator==
bool operator==(const DateTime &other) const
Decides whether two DateTimes are equal.
Definition DateTime.cpp:110

DateTime::reCalculate
void reCalculate(void)
Handle over- and underflowing date/time parts.
Definition DateTime.cpp:160

DateTime::SECONDS_PER_MINUTE
static const short SECONDS_PER_MINUTE
Definition DateTime.h:34

DateTime::operator!=
bool operator!=(const DateTime &other) const
Decides whether two DateTimes are different.
Definition DateTime.cpp:118

DateTime::operator+
DateTime operator+(const DateTime &other) const
Calcluate the summary of two DateTime objects in a new one.
Definition DateTime.cpp:79

DateTime::MONTHS_PER_YEAR
static const short MONTHS_PER_YEAR
Definition DateTime.h:39

DateTime::MINUTES_PER_HOUR
static const short MINUTES_PER_HOUR
Definition DateTime.h:35

DateTime::SECONDS_PER_HOUR
static const short SECONDS_PER_HOUR
Definition DateTime.h:42

DateTime::operator>
bool operator>(const DateTime &other) const
Decides if the left DateTime is later than the right one.
Definition DateTime.cpp:142

DateTime::operator<=
bool operator<=(const DateTime &other) const
Decides if the left DateTime is earlier or equal to the right one.
Definition DateTime.cpp:134

DateTime::DAYS_PER_YEAR
static const int DAYS_PER_YEAR
Definition DateTime.h:37

DateTime::operator-
DateTime operator-(const DateTime &other) const
Calcluate the difference of two DateTime objects in a new one.
Definition DateTime.cpp:102

DateTime::operator-=
DateTime & operator-=(const DateTime &other)
Substracts a DateTime (duration) from the left DateTime object.
Definition DateTime.cpp:89

DateTime::day
int day
Definition DateTime.h:67

DateTime::DAYS_PER_YEAR_AVG
static constexpr float DAYS_PER_YEAR_AVG
Definition DateTime.h:38

DateTime::getDateAsDays
int getDateAsDays() const
Return the date part of the DateTime as days.
Definition DateTime.cpp:46

format
void format(__printf__, 1, 2)))