const type: duration

Describes time and date durations.

const func duration: (attr duration) parse (in string: stri)

Convert a string to a duration.

Parameters:

stri - A duration in the format P[nY][nM][nD][T[nH][nM][n[.n]S]]

Returns:

the duration result of the conversion.

Raises:

RANGE_ERROR - If stri contains not a valid duration value.

const func boolean: (in duration: aDuration1) = (in duration: aDuration2)

Check if two duration values are equal.

Returns:

TRUE if both durations are equal, FALSE otherwise.

const func boolean: (in duration: aDuration1) <> (in duration: aDuration2)

Check if two duration values are not equal.

Returns:

FALSE if both durations are equal, TRUE otherwise.

const func boolean: (in duration: aDuration1) <= (in duration: aDuration2)

Check if aDuration1 is less than or equal to aDuration2.

Returns:

TRUE if aDuration1 is less than or equal to aDuration2, FALSE otherwise.

const func boolean: (in duration: aDuration1) >= (in duration: aDuration2)

Check if aDuration1 is greater than or equal to aDuration2.

Returns:

TRUE if aDuration1 is greater than or equal to aDuration2, FALSE otherwise.

const func boolean: (in duration: aDuration1) < (in duration: aDuration2)

Check if aDuration1 is less than aDuration2.

Returns:

TRUE if aDuration1 is less than aDuration2, FALSE otherwise.

const func boolean: (in duration: aDuration1) > (in duration: aDuration2)

Check if aDuration1 is greater than aDuration2.

Returns:

TRUE if aDuration1 is greater than aDuration2, FALSE otherwise.

const func duration: + (in duration: aDuration)

Plus sign for durations.

Returns:

its operand unchanged.

const func duration: - (in duration: aDuration)

Minus sign, negate a duration.

Returns:

the negated duration.

const func duration: (in duration: aDuration1) + (in duration: aDuration2)

Add two durations.

Returns:

the sum of the two durations.

const func duration: (in duration: aDuration1) - (in duration: aDuration2)

Compute the subtraction of two durations.

Returns:

the difference of the two durations.

const func duration: (in integer: number) * (in duration: aDuration)

Multiply a duration by a number.

Returns:

the multiplied duration.

const func duration: (in duration: aDuration) * (in integer: number)

Multiply a duration by a number.

Returns:

the multiplied duration.

const proc: (inout duration: aDuration) +:= (in duration: delta)

Increment a duration by a delta.

const proc: (inout duration: aDuration) -:= (in duration: delta)

Decrement a duration by a delta.

const proc: (inout time: tim) +:= (in duration: aDuration)

Increment a time by a duration.

const proc: (inout time: tim) -:= (in duration: aDuration)

Decrement a time by a duration.

const func time: (in time: tim) + (in duration: aDuration)

Add a duration to a time.

Returns:

the time result of the addition.

const func time: (in time: tim) - (in duration: aDuration)

Subtract a duration from a time.

Returns:

the time result of the subtraction.

const func duration: (in time: tim1) - (in time: tim2)

Subtract two times.

Returns:

the duration between the two points in time.

const func integer: getYears (in duration: aDuration)

Obtain the years of a duration.

Returns:

the years of a duration.

const func integer: getMonths (in duration: aDuration)

Obtain the months of a duration.

Returns:

the months of a duration.

const func integer: getDays (in duration: aDuration)

Obtain the days of a duration.

Returns:

the days of a duration.

const func integer: getHours (in duration: aDuration)

Obtain the hours of a duration.

Returns:

the hours of a duration.

const func integer: getMinutes (in duration: aDuration)

Obtain the minutes of a duration.

Returns:

the minutes of a duration.

const func integer: getSeconds (in duration: aDuration)

Obtain the seconds of a duration.

Returns:

the seconds of a duration.

const func integer: getMicroSeconds (in duration: aDuration)

Obtain the micro seconds of a duration.

Returns:

the micro seconds of a duration.

const func string: str (in duration: aDuration)

Convert a duration to a string. The duration format is P[nY][nM][nD][T[nH][nM][n[.n]S]], where n is a signed decimal of a date or time element.

str(duration("P1Y2M3DT4H5M6S"))  returns  "P1Y2M3DT4H5M6S"

Returns:

the result of the conversion.

const func string: literal (in duration: aDuration)

Convert a duration to a duration literal.

Returns:

the duration literal.

const func duration: duration (in var string: stri)

Convert a string to a duration.

Parameters:

stri - A duration in the format P[nY][nM][nD][T[nH][nM][n[.n]S]]

Returns:

the duration result of the conversion.

Raises:

RANGE_ERROR - If stri contains not a valid duration value.

const func integer: compare (in duration: aDuration1, in duration: aDuration2)

Compares two durations.

Returns:

-1, 0 or 1 if the first argument is considered to be respectively less than, equal to, or greater than the second.

const func integer: hashCode (in duration: aDuration)

Compute the hash value of aDuration.

Returns:

the hash value.

const func integer: toYears (in duration: aDuration)

Compute the years of aDuration.

Returns:

the duration in years.

const func integer: toMonths (in duration: aDuration)

Compute the months of aDuration.

Returns:

the duration in months.

const func integer: toDays (in duration: aDuration)

Compute the days of aDuration.

Returns:

the duration in days.

const func integer: toHours (in duration: aDuration)

Compute the hours of aDuration.

Returns:

the duration in hours.

const func integer: toMinutes (in duration: aDuration)

Compute the minutes of aDuration.

Returns:

the duration in minutes.

const func integer: toSeconds (in duration: aDuration)

Compute the seconds of aDuration.

Returns:

the duration in seconds.

const func integer: toMicroSeconds (in duration: aDuration)

Compute the micro seconds of aDuration.

Returns:

the duration in micro seconds.

const proc: wait (in duration: aDuration)

Wait for a given duration.