bpf::system::DateTime class
#include <Base/include/Framework/System/DateTime.hpp>

Contents

Container to represent a date time across platforms

Public static functions

static auto UTCNow() -> DateTime
static auto Now() -> DateTime
static auto Parse(const String& str) -> DateTime
static auto TryParse(const String& str, DateTime& date) -> bool

Constructors, destructors, conversion operators

DateTime(fint month, fint day, uint32 year, fint hour = 0, fint minute = 0, fint second = 0)
DateTime()

Public functions

auto GetYear() const -> uint32 noexcept
auto GetDay() const -> fint noexcept
auto GetMonth() const -> fint noexcept
auto GetHours() const -> fint noexcept
auto GetMinutes() const -> fint noexcept
auto GetSeconds() const -> fint noexcept
auto GetMonthName() const -> String
auto GetDayName() const -> String
auto operator+(const TimeSpan& other) const -> DateTime
auto operator-(const DateTime& other) const -> TimeSpan
auto operator-(const TimeSpan& other) const -> DateTime
auto operator>(const DateTime& other) const -> bool
auto operator<(const DateTime& other) const -> bool
auto operator<=(const DateTime& other) const -> bool noexcept
auto operator>=(const DateTime& other) const -> bool noexcept
auto operator==(const DateTime& other) const -> bool
auto operator!=(const DateTime& other) const -> bool
auto ToUTCTime() const -> DateTime
auto ToLocalTime() const -> DateTime

Function documentation

static DateTime bpf::system::DateTime::UTCNow()

Returns new DateTime

Gets the current system time as UTC time

static DateTime bpf::system::DateTime::Now()

Returns new DateTime

Gets the current local system time

static DateTime bpf::system::DateTime::Parse(const String& str)

Parameters
str the string to parse
Returns new DateTime
Exceptions
ParseException when the string cannot be converted to a DateTime

Parse a DateTime from a string

static bool bpf::system::DateTime::TryParse(const String& str, DateTime& date)

Parameters
str the string to parse
date DateTime parsed from string
Returns true if successfull, false otherwise

Parse a DateTime from a string

bpf::system::DateTime::DateTime(fint month, fint day, uint32 year, fint hour = 0, fint minute = 0, fint second = 0)

Parameters
month the month number
day the day number in the month
year the year number
hour the hours count
minute the minutes count
second the seconds count

Constructs a DateTime from individual components

bpf::system::DateTime::DateTime()

Constructs an empty DateTime

uint32 bpf::system::DateTime::GetYear() const noexcept

Returns unsigned 32 bits

Returns the year number

fint bpf::system::DateTime::GetDay() const noexcept

Returns signed 32 bits

Returns the day number in the month

fint bpf::system::DateTime::GetMonth() const noexcept

Returns signed 32 bits

Returns the month number

fint bpf::system::DateTime::GetHours() const noexcept

Returns signed 32 bits

Returns the hours count

fint bpf::system::DateTime::GetMinutes() const noexcept

Returns signed 32 bits

Returns the minutes count

fint bpf::system::DateTime::GetSeconds() const noexcept

Returns signed 32 bits

Returns the seconds count

String bpf::system::DateTime::GetMonthName() const

Returns high-level string

Returns the month name

String bpf::system::DateTime::GetDayName() const

Returns high-level string

Returns the day name

DateTime bpf::system::DateTime::operator+(const TimeSpan& other) const

Parameters
other TimeSpan to add with
Returns new DateTime

Adds a DateTime with a TimeSpan

TimeSpan bpf::system::DateTime::operator-(const DateTime& other) const

Parameters
other DateTime to subtract with
Returns new TimeSpan

Subtract two DateTime

DateTime bpf::system::DateTime::operator-(const TimeSpan& other) const

Parameters
other TimeSpan to subtract with
Returns new DateTime

Subtract a DateTime with a TimeSpan

bool bpf::system::DateTime::operator>(const DateTime& other) const

Parameters
other operand
Returns true if this is greater than other, false otherwise

Compare DateTime

bool bpf::system::DateTime::operator<(const DateTime& other) const

Parameters
other operand
Returns true if this is less than other, false otherwise

Compare DateTime

bool bpf::system::DateTime::operator<=(const DateTime& other) const noexcept

Parameters
other operand
Returns true if this is less than or equal to other, false otherwise

Compare DateTime

bool bpf::system::DateTime::operator>=(const DateTime& other) const noexcept

Parameters
other operand
Returns true if this is greater than or equal to other, false otherwise

Compare DateTime

bool bpf::system::DateTime::operator==(const DateTime& other) const

Parameters
other operand
Returns true if this is equal to other, false otherwise

Compare DateTime

bool bpf::system::DateTime::operator!=(const DateTime& other) const

Parameters
other operand
Returns true if this is not equal to other, false otherwise

Compare DateTime

DateTime bpf::system::DateTime::ToUTCTime() const

Returns new DateTime

Converts this DateTime to a UTC time

DateTime bpf::system::DateTime::ToLocalTime() const

Returns new DateTime

Converts this DateTime to a system localized time