C++ Utilities
5.10.5
Useful C++ classes and routines such as argument parser, IO and conversion utilities
|
Represents an instant in time, typically expressed as a date and time of day. More...
#include <datetime.h>
Public Member Functions | |
constexpr | DateTime () |
Constructs a DateTime. More... | |
constexpr | DateTime (std::uint64_t ticks) |
Constructs a DateTime with the specified number of ticks. More... | |
constexpr std::uint64_t & | ticks () |
Returns a mutable reference to the total ticks. More... | |
constexpr std::uint64_t | totalTicks () const |
Returns the number of ticks which represent the value of the current instance. More... | |
int | year () const |
Returns the year component of the date represented by this instance. More... | |
int | month () const |
Returns the month component of the date represented by this instance. More... | |
int | day () const |
Returns the day component of the date represented by this instance. More... | |
int | dayOfYear () const |
Returns the day of the year represented by this instance. More... | |
constexpr DayOfWeek | dayOfWeek () const |
Returns the day of the week represented by this instance. More... | |
constexpr int | hour () const |
Returns the hour component of the date represented by this instance. More... | |
constexpr int | minute () const |
Returns the minute component of the date represented by this instance. More... | |
constexpr int | second () const |
Returns the second component of the date represented by this instance. More... | |
constexpr int | millisecond () const |
Returns the millisecond component of the date represented by this instance. More... | |
constexpr int | microsecond () const |
Returns the microsecond component of the date represented by this instance. More... | |
constexpr int | nanosecond () const |
Returns the nanosecond component of the date represented by this instance. More... | |
constexpr bool | isNull () const |
Returns true if the date represented by the current DateTime class is null. More... | |
constexpr TimeSpan | timeOfDay () const |
Returns the time of day as TimeSpan for this instance. More... | |
bool | isLeapYear () const |
Returns an indication whether the year represented by this instance is a leap year. More... | |
constexpr bool | isEternity () const |
Returns whether the instance has the maximal number of ticks. More... | |
constexpr bool | isSameDay (const DateTime &other) const |
Returns and indication whether two DateTime instances represent the same day. More... | |
std::string | toString (DateTimeOutputFormat format=DateTimeOutputFormat::DateAndTime, bool noMilliseconds=false) const |
Returns the string representation of the current instance using the specified format. More... | |
void | toString (std::string &result, DateTimeOutputFormat format=DateTimeOutputFormat::DateAndTime, bool noMilliseconds=false) const |
Returns the string representation of the current instance using the specified format. More... | |
std::string | toIsoStringWithCustomDelimiters (TimeSpan timeZoneDelta=TimeSpan(), char dateDelimiter='-', char timeDelimiter=':', char timeZoneDelimiter=':') const |
Returns the string representation of the current instance in the ISO format with custom delimiters, eg. More... | |
std::string | toIsoString (TimeSpan timeZoneDelta=TimeSpan()) const |
Returns the string representation of the current instance in the ISO format, eg. More... | |
constexpr std::time_t | toTimeStamp () const |
Returns the UNIX timestamp for the current instance. More... | |
constexpr bool | operator== (const DateTime &other) const |
Indicates whether two DateTime instances are equal. More... | |
constexpr bool | operator!= (const DateTime &other) const |
Indicates whether two DateTime instances are not equal. More... | |
constexpr bool | operator< (const DateTime &other) const |
Indicates whether a specified DateTime is less than another specified DateTime. More... | |
constexpr bool | operator> (const DateTime &other) const |
Indicates whether a specified DateTime is greater than another specified DateTime. More... | |
constexpr bool | operator<= (const DateTime &other) const |
Indicates whether a specified DateTime is less or equal than another specified DateTime. More... | |
constexpr bool | operator>= (const DateTime &other) const |
Indicates whether a specified DateTime is greater or equal than another specified DateTime. More... | |
constexpr DateTime | operator+ (const TimeSpan &timeSpan) const |
Adds another instance. More... | |
constexpr DateTime | operator- (const TimeSpan &timeSpan) const |
Subtracts another instance. More... | |
constexpr TimeSpan | operator+ (const DateTime &other) const |
Adds two instances. More... | |
constexpr TimeSpan | operator- (const DateTime &other) const |
Subtracts two DateTime instances. More... | |
DateTime & | operator+= (const TimeSpan &timeSpan) |
Adds a TimeSpan to the current instance. More... | |
DateTime & | operator-= (const TimeSpan &timeSpan) |
Subtracts a TimeSpan from the current instance. More... | |
template<typename TimePoint > | |
constexpr DateTime | fromChronoTimePointGmt (TimePoint timePoint) |
Constructs a new DateTime object with the GMT time from the specified std::chrono::time_point. More... | |
Static Public Member Functions | |
static DateTime | fromDate (int year=1, int month=1, int day=1) |
Constructs a DateTime to the specified year, month, and day. More... | |
static DateTime | fromTime (int hour=0, int minute=0, int second=0, double millisecond=0.0) |
Constructs a DateTime to the specified hour, minute, second and millisecond. More... | |
static DateTime | fromDateAndTime (int year=1, int month=1, int day=1, int hour=0, int minute=0, int second=0, double millisecond=0.0) |
Constructs a DateTime to the specified year, month, day, hour, minute, second and millisecond. More... | |
static DateTime | fromString (const std::string &str) |
Parses the given std::string as DateTime. More... | |
static DateTime | fromString (const char *str) |
Parses the given C-style string as DateTime. More... | |
static std::pair< DateTime, TimeSpan > | fromIsoString (const char *str) |
Parses the specified ISO date time denotation provided as C-style string. More... | |
static DateTime | fromIsoStringGmt (const char *str) |
Parses the specified ISO date time denotation provided as C-style string. More... | |
static DateTime | fromIsoStringLocal (const char *str) |
Parses the specified ISO date time denotation provided as C-style string. More... | |
static DateTime | fromTimeStamp (std::time_t timeStamp) |
Constructs a new DateTime object with the local time from the specified UNIX timeStamp. More... | |
constexpr static DateTime | fromTimeStampGmt (std::time_t timeStamp) |
Constructs a new DateTime object with the GMT time from the specified UNIX timeStamp. More... | |
template<typename TimePoint > | |
static DateTime | fromChronoTimePoint (TimePoint timePoint) |
Constructs a new DateTime object with the local time from the specified std::chrono::time_point. More... | |
template<typename TimePoint > | |
constexpr static DateTime | fromChronoTimePointGmt (TimePoint timePoint) |
static const char * | printDayOfWeek (DayOfWeek dayOfWeek, bool abbreviation=false) |
Returns the string representation as C-style string for the given day of week. More... | |
static constexpr DateTime | eternity () |
Constructs a new instance of the DateTime class with the maximal number of ticks. More... | |
static constexpr DateTime | unixEpochStart () |
Returns the DateTime object for the "1970-01-01T00:00:00Z". More... | |
static DateTime | now () |
Returns a DateTime object that is set to the current date and time on this computer, expressed as the local time. More... | |
static DateTime | gmtNow () |
Returns a DateTime object that is set to the current date and time on this computer, expressed as the GMT time. More... | |
constexpr static bool | isLeapYear (int year) |
Returns an indication whether the specified year is a leap year. More... | |
static int | daysInMonth (int year, int month) |
Returns the number of days in the specified month and year. More... | |
Represents an instant in time, typically expressed as a date and time of day.
Definition at line 53 of file datetime.h.
|
inlineexplicitconstexpr |
Constructs a DateTime.
Definition at line 141 of file datetime.h.
|
inlineexplicitconstexpr |
Constructs a DateTime with the specified number of ticks.
Definition at line 149 of file datetime.h.
|
inline |
Returns the day component of the date represented by this instance.
Definition at line 282 of file datetime.h.
|
inlineconstexpr |
Returns the day of the week represented by this instance.
Definition at line 299 of file datetime.h.
|
inline |
Returns the day of the year represented by this instance.
Definition at line 290 of file datetime.h.
|
inlinestatic |
Returns the number of days in the specified month and year.
Definition at line 398 of file datetime.h.
|
inlinestaticconstexpr |
Constructs a new instance of the DateTime class with the maximal number of ticks.
Definition at line 434 of file datetime.h.
|
inlinestatic |
Constructs a new DateTime object with the local time from the specified std::chrono::time_point.
Definition at line 232 of file datetime.h.
|
staticconstexpr |
|
constexpr |
Constructs a new DateTime object with the GMT time from the specified std::chrono::time_point.
Definition at line 242 of file datetime.h.
|
inlinestatic |
Constructs a DateTime to the specified year, month, and day.
Throws | a ConversionException if the specified year, month or day is out-of-range. |
Definition at line 158 of file datetime.h.
|
inlinestatic |
Constructs a DateTime to the specified year, month, day, hour, minute, second and millisecond.
Throws | a ConversionException if the specified year, month, day, hour, minute, second or millisecond is out-of-range. |
Definition at line 177 of file datetime.h.
Parses the specified ISO date time denotation provided as C-style string.
Definition at line 120 of file datetime.cpp.
|
inlinestatic |
Parses the specified ISO date time denotation provided as C-style string.
Throws | a ConversionException if the specified str does not match the expected time format. |
Definition at line 202 of file datetime.h.
|
inlinestatic |
Parses the specified ISO date time denotation provided as C-style string.
Throws | a ConversionException if the specified str does not match the expected time format. |
Definition at line 214 of file datetime.h.
|
static |
Parses the given C-style string as DateTime.
Throws | a ConversionException if the specified str does not match the expected time format. |
The expected format is something like "2012-02-29 15:34:20.033" or "2012/02/29 15:34:20.033". The delimiters '-', ':' and '/' are exchangeable.
Definition at line 79 of file datetime.cpp.
|
inlinestatic |
Parses the given std::string as DateTime.
Throws | a ConversionException if the specified str does not match the expected time format. |
The expected format is something like "2012-02-29 15:34:20.033" or "2012/02/29 15:34:20.033". The delimiters '-', ':' and '/' are exchangeable.
Definition at line 191 of file datetime.h.
|
inlinestatic |
Constructs a DateTime to the specified hour, minute, second and millisecond.
Throws | a ConversionException if the specified hour, minute, second or millisecond is out-of-range. |
Definition at line 167 of file datetime.h.
|
static |
Constructs a new DateTime object with the local time from the specified UNIX timeStamp.
Definition at line 59 of file datetime.cpp.
|
inlinestaticconstexpr |
Constructs a new DateTime object with the GMT time from the specified UNIX timeStamp.
Definition at line 222 of file datetime.h.
|
inlinestatic |
Returns a DateTime object that is set to the current date and time on this computer, expressed as the GMT time.
Definition at line 460 of file datetime.h.
|
inlineconstexpr |
Returns the hour component of the date represented by this instance.
Definition at line 307 of file datetime.h.
|
inlineconstexpr |
Returns whether the instance has the maximal number of ticks.
Definition at line 382 of file datetime.h.
|
inline |
Returns an indication whether the year represented by this instance is a leap year.
Definition at line 374 of file datetime.h.
|
inlinestaticconstexpr |
Returns an indication whether the specified year is a leap year.
Definition at line 390 of file datetime.h.
|
inlineconstexpr |
Returns true if the date represented by the current DateTime class is null.
Definition at line 358 of file datetime.h.
|
inlineconstexpr |
Returns and indication whether two DateTime instances represent the same day.
Definition at line 406 of file datetime.h.
|
inlineconstexpr |
Returns the microsecond component of the date represented by this instance.
Definition at line 339 of file datetime.h.
|
inlineconstexpr |
Returns the millisecond component of the date represented by this instance.
Definition at line 331 of file datetime.h.
|
inlineconstexpr |
Returns the minute component of the date represented by this instance.
Definition at line 315 of file datetime.h.
|
inline |
Returns the month component of the date represented by this instance.
Definition at line 274 of file datetime.h.
|
inlineconstexpr |
Returns the nanosecond component of the date represented by this instance.
Definition at line 349 of file datetime.h.
|
inlinestatic |
Returns a DateTime object that is set to the current date and time on this computer, expressed as the local time.
Definition at line 451 of file datetime.h.
|
inlineconstexpr |
Indicates whether two DateTime instances are not equal.
Definition at line 476 of file datetime.h.
|
inlineconstexpr |
Adds another instance.
Definition at line 517 of file datetime.h.
Adds a TimeSpan to the current instance.
Definition at line 554 of file datetime.h.
|
inlineconstexpr |
Subtracts two DateTime instances.
Definition at line 546 of file datetime.h.
|
inlineconstexpr |
Subtracts another instance.
Definition at line 526 of file datetime.h.
Subtracts a TimeSpan from the current instance.
Definition at line 563 of file datetime.h.
|
inlineconstexpr |
Indicates whether a specified DateTime is less than another specified DateTime.
Definition at line 484 of file datetime.h.
|
inlineconstexpr |
Indicates whether a specified DateTime is less or equal than another specified DateTime.
Definition at line 500 of file datetime.h.
|
inlineconstexpr |
Indicates whether two DateTime instances are equal.
Definition at line 468 of file datetime.h.
|
inlineconstexpr |
Indicates whether a specified DateTime is greater than another specified DateTime.
Definition at line 492 of file datetime.h.
|
inlineconstexpr |
Indicates whether a specified DateTime is greater or equal than another specified DateTime.
Definition at line 508 of file datetime.h.
|
static |
Returns the string representation as C-style string for the given day of week.
If abbreviation is true, only the first three letters of the string will be returned.
Definition at line 331 of file datetime.cpp.
|
inlineconstexpr |
Returns the second component of the date represented by this instance.
Definition at line 323 of file datetime.h.
|
inlineconstexpr |
Returns a mutable reference to the total ticks.
Definition at line 250 of file datetime.h.
|
inlineconstexpr |
Returns the time of day as TimeSpan for this instance.
Definition at line 366 of file datetime.h.
Returns the string representation of the current instance in the ISO format, eg.
2016-08-29T21:32:31.588539814+02:00.
Definition at line 319 of file datetime.cpp.
string CppUtilities::DateTime::toIsoStringWithCustomDelimiters | ( | TimeSpan | timeZoneDelta = TimeSpan() , |
char | dateDelimiter = '-' , |
||
char | timeDelimiter = ':' , |
||
char | timeZoneDelimiter = ':' |
||
) | const |
Returns the string representation of the current instance in the ISO format with custom delimiters, eg.
2016/08/29T21-32-31.588539814+02:00 with '/' as dateDelimiter and '-' as timeDelimiter.
Definition at line 285 of file datetime.cpp.
|
inline |
Returns the string representation of the current instance using the specified format.
Definition at line 416 of file datetime.h.
void CppUtilities::DateTime::toString | ( | std::string & | result, |
DateTimeOutputFormat | format = DateTimeOutputFormat::DateAndTime , |
||
bool | noMilliseconds = false |
||
) | const |
Returns the string representation of the current instance using the specified format.
Definition at line 213 of file datetime.cpp.
|
inlineconstexpr |
Returns the number of ticks which represent the value of the current instance.
Definition at line 258 of file datetime.h.
|
constexpr |
Returns the UNIX timestamp for the current instance.
Definition at line 426 of file datetime.h.
|
inlinestaticconstexpr |
Returns the DateTime object for the "1970-01-01T00:00:00Z".
Definition at line 442 of file datetime.h.
|
inline |
Returns the year component of the date represented by this instance.
Definition at line 266 of file datetime.h.