|
Quick Links: |
#include <bdlt_datetimeinterval.h>
Each object of this class represents a (signed) time interval with microsecond resolution. See The Representation of a Time Interval for details.
See Component bdlt_datetimeinterval
| bdlt::DatetimeInterval::DatetimeInterval | ( | ) |
Create a time interval object having the value 0.
| bdlt::DatetimeInterval::DatetimeInterval | ( | int | days, | |
| bsls::Types::Int64 | hours = 0, |
|||
| bsls::Types::Int64 | minutes = 0, |
|||
| bsls::Types::Int64 | seconds = 0, |
|||
| bsls::Types::Int64 | milliseconds = 0, |
|||
| bsls::Types::Int64 | microseconds = 0 | |||
| ) | [explicit] |
Create a time interval object having the value given by the specified days, and the optionally specified hours, minutes, seconds, milliseconds, and microseconds. Unspecified arguments default to 0. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer). Note that the arguments may be supplied using a mixture of positive, negative, and 0 values.
| bdlt::DatetimeInterval::DatetimeInterval | ( | const DatetimeInterval & | original | ) |
Create a time interval object having the value of the specified original time interval.
| bdlt::DatetimeInterval::~DatetimeInterval | ( | ) |
Destroy this time interval object. Note that this method's definition is generated by the compiler.
| static bool bdlt::DatetimeInterval::isValid | ( | int | days, | |
| bsls::Types::Int64 | hours = 0, |
|||
| bsls::Types::Int64 | minutes = 0, |
|||
| bsls::Types::Int64 | seconds = 0, |
|||
| bsls::Types::Int64 | milliseconds = 0, |
|||
| bsls::Types::Int64 | microseconds = 0 | |||
| ) | [static] |
Return true if a time interval object having the value given by the specified days, and the optionally specified hours, minutes, seconds, milliseconds, and microseconds can be represented as a DatetimeInterval and false otherwise. Unspecified arguments default to 0. The resulting time interval value is valid if the days field does not overflow a 32-bit integer. Note that the arguments may be supplied using a mixture of positive, negative, and 0 values.
| static int bdlt::DatetimeInterval::maxSupportedBdexVersion | ( | int | versionSelector | ) | [static] |
Return the maximum valid BDEX format version, as indicated by the specified versionSelector, to be passed to the bdexStreamOut method. Note that it is highly recommended that versionSelector be formatted as "YYYYMMDD", a date representation. Also note that versionSelector should be a compile-time-chosen value that selects a format version supported by both externalizer and unexternalizer. See the bslx package-level documentation for more information on BDEX streaming of value-semantic types and containers.
| DatetimeInterval& bdlt::DatetimeInterval::operator= | ( | const DatetimeInterval & | rhs | ) |
Assign to this object the value of the specified rhs time interval, and return a reference providing modifiable access to this object.
| DatetimeInterval& bdlt::DatetimeInterval::operator+= | ( | const DatetimeInterval & | rhs | ) |
Add to this time interval the value of the specified rhs time interval, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| DatetimeInterval& bdlt::DatetimeInterval::operator-= | ( | const DatetimeInterval & | rhs | ) |
Subtract from this time interval the value of the specified rhs time interval, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| void bdlt::DatetimeInterval::setInterval | ( | int | days, | |
| bsls::Types::Int64 | hours = 0, |
|||
| bsls::Types::Int64 | minutes = 0, |
|||
| bsls::Types::Int64 | seconds = 0, |
|||
| bsls::Types::Int64 | milliseconds = 0, |
|||
| bsls::Types::Int64 | microseconds = 0 | |||
| ) |
Set the time interval represented by this object to the value given by the specified days, and the optionally specified hours, minutes, seconds, milliseconds, and microseconds. Unspecified arguments default to 0. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer). Note that the arguments may be supplied using a mixture of positive, negative, and 0 values.
| int bdlt::DatetimeInterval::setIntervalIfValid | ( | int | days, | |
| bsls::Types::Int64 | hours = 0, |
|||
| bsls::Types::Int64 | minutes = 0, |
|||
| bsls::Types::Int64 | seconds = 0, |
|||
| bsls::Types::Int64 | milliseconds = 0, |
|||
| bsls::Types::Int64 | microseconds = 0 | |||
| ) |
Set the time interval represented by this object to the value given by the specified days, and the optionally specified hours, minutes, seconds, milliseconds, and microseconds. Unspecified arguments default to 0. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise. Note that the arguments may be supplied using a mixture of positive, negative, and 0 values.
| void bdlt::DatetimeInterval::setTotalDays | ( | int | days | ) |
Set the overall value of this object to indicate the specified number of days.
| void bdlt::DatetimeInterval::setTotalHours | ( | bsls::Types::Int64 | hours | ) |
Set the overall value of this object to indicate the specified number of hours. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::setTotalHoursIfValid | ( | bsls::Types::Int64 | hours | ) |
Set the overall value of this object to indicate the specified number of hours. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| void bdlt::DatetimeInterval::setTotalMinutes | ( | bsls::Types::Int64 | minutes | ) |
Set the overall value of this object to indicate the specified number of minutes. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::setTotalMinutesIfValid | ( | bsls::Types::Int64 | minutes | ) |
Set the overall value of this object to indicate the specified number of minutes. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| void bdlt::DatetimeInterval::setTotalSeconds | ( | bsls::Types::Int64 | seconds | ) |
Set the overall value of this object to indicate the specified number of seconds. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::setTotalSecondsIfValid | ( | bsls::Types::Int64 | seconds | ) |
Set the overall value of this object to indicate the specified number of seconds. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| void bdlt::DatetimeInterval::setTotalSecondsFromDouble | ( | double | seconds | ) |
Set the overall value of this object to indicate the specified number of seconds. The fractional part of seconds, if any, is rounded to the nearest whole number of microseconds. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::setTotalSecondsFromDoubleIfValid | ( | double | seconds | ) |
Set the overall value of this object to indicate the specified number of seconds. The fractional part of seconds, if any, is rounded to the nearest whole number of microseconds. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| void bdlt::DatetimeInterval::setTotalMilliseconds | ( | bsls::Types::Int64 | milliseconds | ) |
Set the overall value of this object to indicate the specified number of milliseconds. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::setTotalMillisecondsIfValid | ( | bsls::Types::Int64 | milliseconds | ) |
Set the overall value of this object to indicate the specified number of milliseconds. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| void bdlt::DatetimeInterval::setTotalMicroseconds | ( | bsls::Types::Int64 | microseconds | ) |
Set the overall value of this object to indicate the specified number of microseconds. Note that there is no setTotalMicrosecondsIfValid because no value of microseconds can cause the number of days to overflow.
| DatetimeInterval& bdlt::DatetimeInterval::addInterval | ( | int | days, | |
| bsls::Types::Int64 | hours = 0, |
|||
| bsls::Types::Int64 | minutes = 0, |
|||
| bsls::Types::Int64 | seconds = 0, |
|||
| bsls::Types::Int64 | milliseconds = 0, |
|||
| bsls::Types::Int64 | microseconds = 0 | |||
| ) |
Add to this time interval the specified number of days, and the optionally specified number of hours, minutes, seconds, milliseconds, and microseconds, and return a reference providing modifiable access to this object. Unspecified arguments default to 0. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer). Note that the arguments may be supplied using a mixture of positive, negative, and 0 values.
| int bdlt::DatetimeInterval::addIntervalIfValid | ( | int | days, | |
| bsls::Types::Int64 | hours = 0, |
|||
| bsls::Types::Int64 | minutes = 0, |
|||
| bsls::Types::Int64 | seconds = 0, |
|||
| bsls::Types::Int64 | milliseconds = 0, |
|||
| bsls::Types::Int64 | microseconds = 0 | |||
| ) |
Add to this time interval the specified number of days, and the optionally specified number of hours, minutes, seconds, milliseconds, and microseconds. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise. Note that the arguments may be supplied using a mixture of positive, negative, and 0 values.
| DatetimeInterval& bdlt::DatetimeInterval::addDays | ( | int | days | ) |
Add to this time interval the specified number of days, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::addDaysIfValid | ( | int | days | ) |
Add to this time interval the specified number of days. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| DatetimeInterval& bdlt::DatetimeInterval::addHours | ( | bsls::Types::Int64 | hours | ) |
Add to this time interval the specified number of hours, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::addHoursIfValid | ( | bsls::Types::Int64 | hours | ) |
Add to this time interval the specified number of hours. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| DatetimeInterval& bdlt::DatetimeInterval::addMinutes | ( | bsls::Types::Int64 | minutes | ) |
Add to this time interval the specified number of minutes, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::addMinutesIfValid | ( | bsls::Types::Int64 | minutes | ) |
Add to this time interval the specified number of minutes. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| DatetimeInterval& bdlt::DatetimeInterval::addSeconds | ( | bsls::Types::Int64 | seconds | ) |
Add to this time interval the specified number of seconds, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::addSecondsIfValid | ( | bsls::Types::Int64 | seconds | ) |
Add to this time interval the specified number of seconds. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| DatetimeInterval& bdlt::DatetimeInterval::addMilliseconds | ( | bsls::Types::Int64 | milliseconds | ) |
Add to this time interval the specified number of milliseconds, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::addMillisecondsIfValid | ( | bsls::Types::Int64 | milliseconds | ) |
Add to this time interval the specified number of milliseconds. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| DatetimeInterval& bdlt::DatetimeInterval::addMicroseconds | ( | bsls::Types::Int64 | microseconds | ) |
Add to this time interval the specified number of microseconds, and return a reference providing modifiable access to this object. The behavior is undefined unless the resulting time interval value is valid (i.e., the days field must not overflow a 32-bit integer).
| int bdlt::DatetimeInterval::addMicrosecondsIfValid | ( | bsls::Types::Int64 | microseconds | ) |
Add to this time interval the specified number of microseconds. Return 0 if the resulting time interval value is valid (i.e., the days field must not overflow an int) and a non-zero value (with no effect) otherwise.
| STREAM& bdlt::DatetimeInterval::bdexStreamIn | ( | STREAM & | stream, | |
| int | version | |||
| ) |
Assign to this object the value read from the specified input stream using the specified version format, and return a reference to stream. If stream is initially invalid, this operation has no effect. If version is not supported, this object is unaltered and stream is invalidated, but otherwise unmodified. If version is supported but stream becomes invalid during this operation, this object has an undefined, but valid, state. Note that no version is read from stream. See the bslx package-level documentation for more information on BDEX streaming of value-semantic types and containers.
| int bdlt::DatetimeInterval::days | ( | ) | const |
Return the days field in the canonical representation of the value of this time interval. Note that the return value may be negative. Also note that the return value is the same as that returned by totalDays.
| bsls::Types::Int64 bdlt::DatetimeInterval::fractionalDayInMicroseconds | ( | ) | const |
Return the value of this time interval as an integral number of microseconds modulo the number of microseconds in a day. Note that the return value may be negative.
| int bdlt::DatetimeInterval::hours | ( | ) | const |
Return the hours field in the canonical representation of the value of this time interval. Note that the return value may be negative.
| int bdlt::DatetimeInterval::minutes | ( | ) | const |
Return the minutes field in the canonical representation of the value of this time interval. Note that the return value may be negative.
| int bdlt::DatetimeInterval::seconds | ( | ) | const |
Return the seconds field in the canonical representation of the value of this time interval. Note that the return value may be negative.
| int bdlt::DatetimeInterval::milliseconds | ( | ) | const |
Return the milliseconds field in the canonical representation of the value of this time interval. Note that the return value may be negative.
| int bdlt::DatetimeInterval::microseconds | ( | ) | const |
Return the microseconds field in the canonical representation of the value of this time interval. Note that the return value may be negative.
| int bdlt::DatetimeInterval::printToBuffer | ( | char * | result, | |
| int | numBytes, | |||
| int | fractionalSecondPrecision = 6 | |||
| ) | const |
Efficiently write to the specified result buffer no more than the specified numBytes of a representation of the value of this object. Optionally specify fractionalSecondPrecision digits to indicate how many fractional second digits to output. If fractionalSecondPrecision is not specified then 6 fractional second digits will be output (3 digits for milliseconds and 3 digits for microseconds). Return the number of characters (not including the null character) that would have been written if the limit due to numBytes were not imposed. result is null-terminated unless numBytes is 0. The behavior is undefined unless 0 <= numBytes, 0 <= fractionalSecondPrecision <= 6, and result refers to at least numBytes contiguous bytes. Note that the return value is greater than or equal to numBytes if the output representation was truncated to avoid result overrun.
| int bdlt::DatetimeInterval::totalDays | ( | ) | const |
Return the value of this time interval in integral days, rounded toward 0. Note that the return value may be negative. Also note that the return value is the same as that returned by days.
| bsls::Types::Int64 bdlt::DatetimeInterval::totalHours | ( | ) | const |
Return the value of this time interval in integral hours, rounded toward 0. Note that the return value may be negative.
| bsls::Types::Int64 bdlt::DatetimeInterval::totalMinutes | ( | ) | const |
Return the value of this time interval in integral minutes, rounded toward 0. Note that the return value may be negative.
| bsls::Types::Int64 bdlt::DatetimeInterval::totalSeconds | ( | ) | const |
Return the value of this time interval in integral seconds, rounded toward 0. Note that the return value may be negative.
| double bdlt::DatetimeInterval::totalSecondsAsDouble | ( | ) | const |
Return the value of this time interval in seconds as a double, potentially with a fractional part. Note that the return value may be negative. Also note that the conversion from the internal representation to double may lose precision.
| bsls::Types::Int64 bdlt::DatetimeInterval::totalMilliseconds | ( | ) | const |
Return the value of this time interval in integral milliseconds, rounded towards zero. Note that the return value may be negative.
| bsls::Types::Int64 bdlt::DatetimeInterval::totalMicroseconds | ( | ) | const |
Return the value of this time interval as an integral number of microseconds. The behavior is undefined unless the number of microseconds can be represented with a 64-bit signed integer. Note that the return value may be negative.
| STREAM& bdlt::DatetimeInterval::bdexStreamOut | ( | STREAM & | stream, | |
| int | version | |||
| ) | const |
Write the value of this object, using the specified version format, to the specified output stream, and return a reference to stream. If stream is initially invalid, this operation has no effect. If version is not supported, stream is invalidated, but otherwise unmodified. Note that version is not written to stream. See the bslx package-level documentation for more information on BDEX streaming of value-semantic types and containers.
| bsl::ostream& bdlt::DatetimeInterval::print | ( | bsl::ostream & | stream, | |
| int | level = 0, |
|||
| int | spacesPerLevel = 4 | |||
| ) | const |
Write the value of this object to the specified output stream in a human-readable format, and return a reference to stream. Optionally specify an initial indentation level, whose absolute value is incremented recursively for nested objects. If level is specified, optionally specify spacesPerLevel, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). If stream is not valid on entry, this operation has no effect. Note that the format is not fully specified, and can change without notice.
| static int bdlt::DatetimeInterval::maxSupportedBdexVersion | ( | ) | [static] |
DEPRECATED: Use maxSupportedBdexVersion(int) instead.
Return the most current BDEX streaming version number supported by this class.
| static int bdlt::DatetimeInterval::maxSupportedVersion | ( | ) | [static] |
DEPRECATED: Use maxSupportedBdexVersion(int) instead.
Return the most current BDEX streaming version number supported by this class.
| bsl::ostream& bdlt::DatetimeInterval::streamOut | ( | bsl::ostream & | stream | ) | const |
DEPRECATED: use operator<< or print instead.
Format this datetime interval to the specified output stream, and return a reference to stream.
| DatetimeInterval operator- | ( | const DatetimeInterval & | ) | [friend] |
Return a DatetimeInterval object whose value is the negative of the specified time interval value. The behavior is undefined unless INT_MIN < value.days().
| bool operator== | ( | const DatetimeInterval & | , | |
| const DatetimeInterval & | ||||
| ) | [friend] |
Return true if the specified lhs and rhs time intervals have the same value, and false otherwise. Two time intervals have the same value if all of the corresponding values of their days, hours, minutes, seconds, milliseconds, and microseconds fields are the same.
| bool operator!= | ( | const DatetimeInterval & | , | |
| const DatetimeInterval & | ||||
| ) | [friend] |
Return true if the specified lhs and rhs time intervals do not have the same value, and false otherwise. Two time intervals do not have the same value if any of the corresponding values of their days, hours, minutes, seconds, milliseconds, or microseconds fields is not the same.
| bool operator< | ( | const DatetimeInterval & | , | |
| const DatetimeInterval & | ||||
| ) | [friend] |
| bool operator<= | ( | const DatetimeInterval & | , | |
| const DatetimeInterval & | ||||
| ) | [friend] |
| bool operator> | ( | const DatetimeInterval & | , | |
| const DatetimeInterval & | ||||
| ) | [friend] |
| bool operator>= | ( | const DatetimeInterval & | , | |
| const DatetimeInterval & | ||||
| ) | [friend] |
Return true if the nominal relation between the specified lhs and rhs time interval values holds, and false otherwise. lhs is less than rhs if the following expression evaluates to true:
lhs.days() < rhs.days()
|| (lhs.days() == rhs.days() && lhs.fractionalDayInMicroseconds()
< rhs.fractionalDayInMicroseconds())
The other relationships are defined similarly.
| void hashAppend | ( | HASHALG & | , | |
| const DatetimeInterval & | ||||
| ) | [friend] |
Pass the specified object to the specified hashAlg. This function integrates with the bslh modular hashing system and effectively provides a bsl::hash specialization for DatetimeInterval.
const bsls::Types::Int64 bdlt::DatetimeInterval::k_MILLISECONDS_MAX = 185542587187199999LL [static] |
const bsls::Types::Int64 bdlt::DatetimeInterval::k_MILLISECONDS_MIN [static] |
1.7.1