doxygen/html/DateTime_8h_source.html

#ifndef DATE_TIME_H

#define DATE_TIME_H


#include "EnumHelper.h"

#include <ctime>


auto

StringToDayInYear(const std::string& sDayInYear) -> int;


const int NUM_LAST_DAYS = 7;

const int NUM_LAST_WEEKS = 52;

const int DAYS_IN_YEAR = 366;

const int HOURS_IN_DAY = 24;

const int DAYS_IN_WEEK = 7;

enum Month

{

    Month_January,

    Month_February,

    Month_March,

    Month_April,

    Month_May,

    Month_June,

    Month_July,

    Month_August,

    Month_September,

    Month_October,

    Month_November,

    Month_December,

    NUM_Month = 12,

    Month_Invalid

};


auto

DayInYearToString(int iDayInYearIndex) -> std::string;

auto

LastDayToString(int iLastDayIndex) -> std::string;

auto

LastDayToLocalizedString(int iLastDayIndex) -> std::string;

auto

DayOfWeekToString(int iDayOfWeekIndex) -> std::string;

auto

DayOfWeekToLocalizedString(int iDayOfWeekIndex) -> std::string;

auto

HourInDayToString(int iHourIndex) -> std::string;

auto

HourInDayToLocalizedString(int iHourIndex) -> std::string;

auto

MonthToString(Month month) -> const std::string&;

auto

MonthToLocalizedString(Month month) -> const std::string&;

auto

LastWeekToString(int iLastWeekIndex) -> std::string;

auto

LastWeekToLocalizedString(int iLastWeekIndex) -> std::string;

LuaDeclareType(Month);


auto

AddDays(tm start, int iDaysToMove) -> tm;

auto

GetYesterday(tm start) -> tm;

auto

GetDayOfWeek(tm time) -> int;

auto

GetNextSunday(tm start) -> tm;


auto

GetDayInYearAndYear(int iDayInYearIndex, int iYear) -> tm;


struct DateTime

{

    int tm_sec;

    int tm_min;

    int tm_hour;

    int tm_mday;

    int tm_mon;

    int tm_year;


    DateTime();

    void Init();


    auto operator<(const DateTime& other) const -> bool;

    auto operator>(const DateTime& other) const -> bool;

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


    auto operator!=(const DateTime& other) const -> bool

    {

        return !operator==(other);

    }


    auto operator<=(const DateTime& other) const -> bool

    {

        return !operator>(other);

    }


    auto operator>=(const DateTime& other) const -> bool

    {

        return !operator<(other);

    }


    static auto GetNowDateTime() -> DateTime;

    static auto GetNowDate() -> DateTime;


    static auto GetFromString(const std::string& str) -> DateTime;


    static auto GetYesterday() -> DateTime;


    void StripTime();


    [[nodiscard]] auto GetString() const -> std::string;

    auto FromString(const std::string& sDateTime) -> bool;

};


#endif

DateTime
A standard way of determining the date and the time.
Definition DateTime.h:81

DateTime::tm_mday
int tm_mday
The specified day of the current month.
Definition DateTime.h:104

DateTime::tm_mon
int tm_mon
The number of months since January.
Definition DateTime.h:109

DateTime::FromString
auto FromString(const std::string &sDateTime) -> bool
Attempt to turn a string into a DateTime.
Definition DateTime.cpp:127

DateTime::tm_sec
int tm_sec
The number of seconds after the minute.
Definition DateTime.h:86

DateTime::DateTime
DateTime()
Set up a default date and time.
Definition DateTime.cpp:10

DateTime::tm_hour
int tm_hour
The number of hours since midnight (or 0000 hours).
Definition DateTime.h:96

DateTime::GetNowDateTime
static auto GetNowDateTime() -> DateTime
Retrieve the current date and time.
Definition DateTime.cpp:72

DateTime::tm_min
int tm_min
The number of minutes after the hour.
Definition DateTime.h:91

DateTime::GetNowDate
static auto GetNowDate() -> DateTime
Retrieve the current date.
Definition DateTime.cpp:90

DateTime::tm_year
int tm_year
The number of years since the year 1900.
Definition DateTime.h:111

DateTime::operator>=
auto operator>=(const DateTime &other) const -> bool
Determine if this DateTime is greater than or equal to some other time.
Definition DateTime.h:160

DateTime::operator==
auto operator==(const DateTime &other) const -> bool
Determine if this DateTime is equal to some other time.
Definition DateTime.cpp:39

DateTime::StripTime
void StripTime()
Remove the time portion from the date.
Definition DateTime.cpp:106

DateTime::GetString
auto GetString() const -> std::string
Retrieve a string representation of the current date and time.
Definition DateTime.cpp:115

DateTime::Init
void Init()
Initialize the date and time.
Definition DateTime.cpp:16

DateTime::operator<
auto operator<(const DateTime &other) const -> bool
Determine if this DateTime is less than some other time.
Definition DateTime.cpp:22

DateTime::operator>
auto operator>(const DateTime &other) const -> bool
Determine if this DateTime is greater than some other time.
Definition DateTime.cpp:55

DateTime::operator!=
auto operator!=(const DateTime &other) const -> bool
Determine if this DateTime is not equal to some other time.
Definition DateTime.h:139

DateTime::operator<=
auto operator<=(const DateTime &other) const -> bool
Determine if this DateTime is less than or equal to some other time.
Definition DateTime.h:149