C++ Utilities
4.17.0
Useful C++ classes and routines such as argument parser, IO and conversion utilities
|
Represents a time interval. More...
#include <timespan.h>
Public Member Functions | |
constexpr | TimeSpan () |
Constructs a new instance of the TimeSpan class with zero ticks. More... | |
constexpr | TimeSpan (int64 ticks) |
Constructs a new instance of the TimeSpan class with the specified number of ticks. More... | |
int64 & | ticks () |
Returns a mutable reference to the total ticks. More... | |
constexpr int64 | totalTicks () const |
Returns the number of ticks that represent the value of the current TimeSpan class. More... | |
constexpr double | totalMicroseconds () const |
Returns the value of the current TimeSpan class expressed in whole and fractional microseconds. More... | |
constexpr double | totalMilliseconds () const |
Returns the value of the current TimeSpan class expressed in whole and fractional milliseconds. More... | |
constexpr double | totalSeconds () const |
Returns the value of the current TimeSpan class expressed in whole and fractional seconds. More... | |
constexpr double | totalMinutes () const |
Returns the value of the current TimeSpan class expressed in whole and fractional minutes. More... | |
constexpr double | totalHours () const |
Returns the value of the current TimeSpan class expressed in whole and fractional hours. More... | |
constexpr double | totalDays () const |
Returns the value of the current TimeSpan class expressed in whole and fractional days. More... | |
constexpr int | nanoseconds () const |
Returns the nanoseconds component of the time interval represented by the current TimeSpan class. More... | |
constexpr int | microseconds () const |
Returns the microseconds component of the time interval represented by the current TimeSpan class. More... | |
constexpr int | milliseconds () const |
Returns the miliseconds component of the time interval represented by the current TimeSpan class. More... | |
constexpr int | seconds () const |
Returns the seconds component of the time interval represented by the current TimeSpan class. More... | |
constexpr int | minutes () const |
Returns the minutes component of the time interval represented by the current TimeSpan class. More... | |
constexpr int | hours () const |
Returns the hours component of the time interval represented by the current TimeSpan class. More... | |
constexpr int | days () const |
Returns the days component of the time interval represented by the current TimeSpan class. More... | |
constexpr bool | operator== (const TimeSpan &other) const |
Indicates whether two TimeSpan instances are equal. More... | |
constexpr bool | operator!= (const TimeSpan &other) const |
Indicates whether two TimeSpan instances are not equal. More... | |
constexpr bool | operator< (const TimeSpan &other) const |
Indicates whether a specified TimeSpan is less than another specified TimeSpan. More... | |
constexpr bool | operator> (const TimeSpan &other) const |
Indicates whether a specified TimeSpan is greater than another specified TimeSpan. More... | |
constexpr bool | operator<= (const TimeSpan &other) const |
Indicates whether a specified TimeSpan is less or equal than another specified TimeSpan. More... | |
constexpr bool | operator>= (const TimeSpan &other) const |
Indicates whether a specified TimeSpan is greater or equal than another specified TimeSpan. More... | |
constexpr TimeSpan | operator+ (const TimeSpan &other) const |
Adds two TimeSpan instances. More... | |
constexpr TimeSpan | operator- (const TimeSpan &other) const |
Substracts two TimeSpan instances. More... | |
TimeSpan & | operator+= (const TimeSpan &other) |
Adds another TimeSpan to the current instance. More... | |
TimeSpan & | operator-= (const TimeSpan &other) |
Substracts another TimeSpan from the current instance. More... | |
std::string | toString (TimeSpanOutputFormat format=TimeSpanOutputFormat::Normal, bool fullSeconds=false) const |
Converts the value of the current TimeSpan object to its equivalent std::string representation according the given format. More... | |
void | toString (std::string &result, TimeSpanOutputFormat format=TimeSpanOutputFormat::Normal, bool fullSeconds=false) const |
Converts the value of the current TimeSpan object to its equivalent std::string representation according the given format. More... | |
constexpr bool | isNull () const |
Returns ture if the time interval represented by the current TimeSpan class is null. More... | |
constexpr bool | isNegative () const |
Returns ture if the time interval represented by the current TimeSpan class is negative. More... | |
constexpr bool | isNegativeInfinity () const |
Returns whether the time inverval represented by the current instance is the smallest representable TimeSpan. More... | |
constexpr bool | isInfinity () const |
Returns whether the time inverval represented by the current instance is the longest representable TimeSpan. More... | |
Static Public Member Functions | |
static constexpr TimeSpan | fromMilliseconds (double milliseconds) |
Constructs a new instance of the TimeSpan class with the specified number of miliseconds. More... | |
static constexpr TimeSpan | fromSeconds (double seconds) |
Constructs a new instance of the TimeSpan class with the specified number of seconds. More... | |
static constexpr TimeSpan | fromMinutes (double minutes) |
Constructs a new instance of the TimeSpan class with the specified number of minutes. More... | |
static constexpr TimeSpan | fromHours (double hours) |
Constructs a new instance of the TimeSpan class with the specified number of hours. More... | |
static constexpr TimeSpan | fromDays (double days) |
Constructs a new instance of the TimeSpan class with the specified number of days. More... | |
static TimeSpan | fromString (const std::string &str, char separator=':') |
Parses the given std::string as TimeSpan. More... | |
static TimeSpan | fromString (const char *str, char separator) |
Parses the given C-style string as TimeSpan. More... | |
static constexpr TimeSpan | negativeInfinity () |
Constructs a new instace of the TimeSpan class with the minimal number of ticks. More... | |
static constexpr TimeSpan | infinity () |
Constructs a new instace of the TimeSpan class with the maximal number of ticks. More... | |
Static Public Attributes | |
static constexpr int64 | nanosecondsPerTick = 100uL |
static constexpr int64 | ticksPerMicrosecond = 10uL |
static constexpr uint64 | ticksPerMillisecond = 10000uL |
static constexpr uint64 | ticksPerSecond = 10000000uL |
static constexpr uint64 | ticksPerMinute = 600000000uL |
static constexpr uint64 | ticksPerHour = 36000000000uL |
static constexpr uint64 | ticksPerDay = 864000000000uL |
Friends | |
class | DateTime |
Represents a time interval.
Note that the TimeSpan class is meant to express a time interval independently of the concrete starting DateTime and end DateTime and hence can not be expressed in years and month. For that use case, use the Period class instead.
Definition at line 28 of file timespan.h.
|
inlineexplicit |
Constructs a new instance of the TimeSpan class with zero ticks.
Definition at line 103 of file timespan.h.
|
inlineexplicit |
Constructs a new instance of the TimeSpan class with the specified number of ticks.
Definition at line 111 of file timespan.h.
|
inline |
Returns the days component of the time interval represented by the current TimeSpan class.
Definition at line 302 of file timespan.h.
|
inlinestatic |
Constructs a new instance of the TimeSpan class with the specified number of days.
Definition at line 151 of file timespan.h.
|
inlinestatic |
Constructs a new instance of the TimeSpan class with the specified number of hours.
Definition at line 143 of file timespan.h.
|
inlinestatic |
Constructs a new instance of the TimeSpan class with the specified number of miliseconds.
Definition at line 119 of file timespan.h.
|
inlinestatic |
Constructs a new instance of the TimeSpan class with the specified number of minutes.
Definition at line 135 of file timespan.h.
|
inlinestatic |
Constructs a new instance of the TimeSpan class with the specified number of seconds.
Definition at line 127 of file timespan.h.
|
inlinestatic |
Parses the given std::string as TimeSpan.
Throws | a ConversionException if the specified str does not match the expected format. |
The expected format is "days:hours:minutes:seconds", eg. "5:31:4.521" for 5 hours, 31 minutes and 4.521 seconds. So parts at the front can be omitted and the parts can be fractions. The colon can be changed by specifying another separator.
Definition at line 164 of file timespan.h.
|
static |
Parses the given C-style string as TimeSpan.
Throws | a ConversionException if the specified str does not match the expected format. |
The expected format is "days:hours:minutes:seconds", eg. "5:31:4.521" for 5 hours, 31 minutes and 4.521 seconds. So parts at the front can be omitted and the parts can be fractions. The colon can be changed by specifying another separator.
Definition at line 36 of file timespan.cpp.
|
inline |
Returns the hours component of the time interval represented by the current TimeSpan class.
Definition at line 294 of file timespan.h.
|
inlinestatic |
Constructs a new instace of the TimeSpan class with the maximal number of ticks.
Definition at line 180 of file timespan.h.
|
inline |
Returns whether the time inverval represented by the current instance is the longest representable TimeSpan.
Definition at line 416 of file timespan.h.
|
inline |
Returns ture if the time interval represented by the current TimeSpan class is negative.
Definition at line 400 of file timespan.h.
|
inline |
Returns whether the time inverval represented by the current instance is the smallest representable TimeSpan.
Definition at line 408 of file timespan.h.
|
inline |
Returns ture if the time interval represented by the current TimeSpan class is null.
Definition at line 392 of file timespan.h.
constexpr int ChronoUtilities::TimeSpan::microseconds | ( | ) | const |
Returns the microseconds component of the time interval represented by the current TimeSpan class.
Definition at line 262 of file timespan.h.
|
inline |
Returns the miliseconds component of the time interval represented by the current TimeSpan class.
Definition at line 270 of file timespan.h.
|
inline |
Returns the minutes component of the time interval represented by the current TimeSpan class.
Definition at line 286 of file timespan.h.
constexpr int ChronoUtilities::TimeSpan::nanoseconds | ( | ) | const |
Returns the nanoseconds component of the time interval represented by the current TimeSpan class.
Definition at line 254 of file timespan.h.
|
inlinestatic |
Constructs a new instace of the TimeSpan class with the minimal number of ticks.
Definition at line 172 of file timespan.h.
|
inline |
Indicates whether two TimeSpan instances are not equal.
Definition at line 318 of file timespan.h.
Adds two TimeSpan instances.
Definition at line 358 of file timespan.h.
Adds another TimeSpan to the current instance.
Definition at line 374 of file timespan.h.
Substracts two TimeSpan instances.
Definition at line 366 of file timespan.h.
Substracts another TimeSpan from the current instance.
Definition at line 383 of file timespan.h.
|
inline |
Indicates whether a specified TimeSpan is less than another specified TimeSpan.
Definition at line 326 of file timespan.h.
|
inline |
Indicates whether a specified TimeSpan is less or equal than another specified TimeSpan.
Definition at line 342 of file timespan.h.
|
inline |
Indicates whether two TimeSpan instances are equal.
Definition at line 310 of file timespan.h.
|
inline |
Indicates whether a specified TimeSpan is greater than another specified TimeSpan.
Definition at line 334 of file timespan.h.
|
inline |
Indicates whether a specified TimeSpan is greater or equal than another specified TimeSpan.
Definition at line 350 of file timespan.h.
|
inline |
Returns the seconds component of the time interval represented by the current TimeSpan class.
Definition at line 278 of file timespan.h.
|
inline |
Returns a mutable reference to the total ticks.
Definition at line 188 of file timespan.h.
string TimeSpan::toString | ( | TimeSpanOutputFormat | format = TimeSpanOutputFormat::Normal , |
bool | fullSeconds = false |
||
) | const |
Converts the value of the current TimeSpan object to its equivalent std::string representation according the given format.
If fullSeconds is true the time interval will be rounded to full seconds.
Definition at line 79 of file timespan.cpp.
void TimeSpan::toString | ( | std::string & | result, |
TimeSpanOutputFormat | format = TimeSpanOutputFormat::Normal , |
||
bool | fullSeconds = false |
||
) | const |
Converts the value of the current TimeSpan object to its equivalent std::string representation according the given format.
If fullSeconds is true the time interval will be rounded to full seconds.
The string representation will be stored in result.
Definition at line 94 of file timespan.cpp.
|
inline |
Returns the value of the current TimeSpan class expressed in whole and fractional days.
Definition at line 244 of file timespan.h.
|
inline |
Returns the value of the current TimeSpan class expressed in whole and fractional hours.
Definition at line 236 of file timespan.h.
constexpr double ChronoUtilities::TimeSpan::totalMicroseconds | ( | ) | const |
Returns the value of the current TimeSpan class expressed in whole and fractional microseconds.
Definition at line 204 of file timespan.h.
|
inline |
Returns the value of the current TimeSpan class expressed in whole and fractional milliseconds.
Definition at line 212 of file timespan.h.
|
inline |
Returns the value of the current TimeSpan class expressed in whole and fractional minutes.
Definition at line 228 of file timespan.h.
|
inline |
Returns the value of the current TimeSpan class expressed in whole and fractional seconds.
Definition at line 220 of file timespan.h.
|
inline |
Returns the number of ticks that represent the value of the current TimeSpan class.
Definition at line 196 of file timespan.h.
|
friend |
Definition at line 29 of file timespan.h.
|
static |
Definition at line 81 of file timespan.h.
|
static |
Definition at line 87 of file timespan.h.
|
static |
Definition at line 86 of file timespan.h.
|
static |
Definition at line 82 of file timespan.h.
|
static |
Definition at line 83 of file timespan.h.
|
static |
Definition at line 85 of file timespan.h.
|
static |
Definition at line 84 of file timespan.h.