BloombergLP::bdlt::DatetimeInterval::addInterval

Add the specified field values to this time interval.

Synopsis

Declared in <bdlt_datetimeinterval.h>

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);

Description

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.

Return Value

a reference providing modifiable access to this object

Parameters

NameDescription
daysday count to add
hourshour count to add (optional)
minutesminute count to add (optional)
secondssecond count to add (optional)
millisecondsmillisecond count to add (optional)
microsecondsmicrosecond count to add (optional)