A span of elapsed time expressed with nanosecond precision. More...

Inheritance diagram for org.omg.dds.core.Duration:

Collaboration diagram for org.omg.dds.core.Duration:

Public Member Functions
abstract Duration	add (Duration duration)

abstract Duration	add (long duration, TimeUnit unit)

abstract long	getDuration (TimeUnit inThisUnit)
	Truncate this duration to a whole-number quantity of the given time unit. More...

ServiceEnvironment	getEnvironment ()

abstract long	getRemainder (TimeUnit primaryUnit, TimeUnit remainderUnit)
	If getting the magnitude of this duration in the given `primaryUnit` would cause truncation with respect to the given `remainderUnit`, return the magnitude of the truncation in the latter (presumably finer-grained) unit. More...

abstract boolean	isInfinite ()
	Report whether this duration lasts forever. More...

abstract boolean	isZero ()
	Report whether this duration lasts no time at all. More...

abstract Duration	subtract (Duration duration)

abstract Duration	subtract (long duration, TimeUnit unit)

Static Public Member Functions
static Duration	infiniteDuration (ServiceEnvironment env)

static Duration	newDuration (long duration, TimeUnit unit, ServiceEnvironment env)
	Construct a time duration of the given magnitude. More...

static Duration	zeroDuration (ServiceEnvironment env)

Detailed Description

A span of elapsed time expressed with nanosecond precision.

Instances of this type are immutable.

Definition at line 35 of file Duration.java.

Member Function Documentation

◆ add() [1/2]

abstract Duration org.omg.dds.core.Duration.add ( Duration duration )

abstract

Returns: a new Duration that is the sum of this Duration and the given Duration.

◆ add() [2/2]

abstract Duration org.omg.dds.core.Duration.add	(	long	duration,
		TimeUnit	unit
	)

abstract

Returns: a new Duration that is the sum of this Duration and the given duration.

◆ getDuration()

abstract long org.omg.dds.core.Duration.getDuration ( TimeUnit inThisUnit )

abstract

Truncate this duration to a whole-number quantity of the given time unit.

For example, if this duration is equal to one second plus 100 nanoseconds, calling this method with an argument of TimeUnit#SECONDS will result in the value 1.

If this duration is infinite, this method shall return Long#MAX_VALUE, regardless of the units given.

If this duration cannot be expressed in the given units without overflowing, this method shall return Long#MAX_VALUE. In such a case, the caller may wish to use this method in combination with getRemainder(TimeUnit, TimeUnit) to obtain the full duration without lack of precision.

Parameters

inThisUnit The time unit in which the return result will be measured.

See also: getRemainder(TimeUnit, TimeUnit); Long::MAX_VALUE; TimeUnit

◆ getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns: the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

◆ getRemainder()

abstract long org.omg.dds.core.Duration.getRemainder	(	TimeUnit	primaryUnit,
		TimeUnit	remainderUnit
	)

abstract

If getting the magnitude of this duration in the given primaryUnit would cause truncation with respect to the given remainderUnit, return the magnitude of the truncation in the latter (presumably finer-grained) unit.

For example, if this duration is equal to one second plus 100 nanoseconds, calling this method with arguments of TimeUnit#SECONDS and TimeUnit#NANOSECONDS respectively will result in the value 100.

This method is equivalent to the following pseudo-code:

(this - getDuration(primaryUnit)).getDuration(remainderUnit)

If remainderUnit is represents a coarser granularity than primaryUnit (for example, the former is TimeUnit#MILLISECONDS but the latter is TimeUnit#SECONDS), this method shall return 0.

If the resulting duration cannot be expressed in the given units without overflowing, this method shall return Long#MAX_VALUE.

Parameters

primaryUnit
remainderUnit	The time unit in which the return result will be measured.

See also: getDuration(TimeUnit); Long::MAX_VALUE; TimeUnit

◆ infiniteDuration()

static Duration org.omg.dds.core.Duration.infiniteDuration ( ServiceEnvironment env )

static

Parameters

env	Identifies the Service instance to which the object will belong.

Returns: An unmodifiable org.omg.dds.core.Duration of infinite length.

Definition at line 81 of file Duration.java.

◆ isInfinite()

abstract boolean org.omg.dds.core.Duration.isInfinite ( )

abstract

Report whether this duration lasts forever.

If this duration is infinite, the following relationship shall be true:

this.equals(infiniteDuration(this.getEnvironment()))

See also: infiniteDuration(ServiceEnvironment)

◆ isZero()

abstract boolean org.omg.dds.core.Duration.isZero ( )

abstract

Report whether this duration lasts no time at all.

The result of this method is equivalent to the following:

this.getDuration(TimeUnit.NANOSECONDS) == 0;

See also: getDuration(TimeUnit)

◆ newDuration()

static Duration org.omg.dds.core.Duration.newDuration	(	long	duration,
		TimeUnit	unit,
		ServiceEnvironment	env
	)

static

Construct a time duration of the given magnitude.

A duration of magnitude Long#MAX_VALUE indicates an infinite duration, regardless of the units specified.

Parameters

env	Identifies the Service instance to which the new object will belong.

See also: isInfinite(); infiniteDuration(ServiceEnvironment)

Definition at line 62 of file Duration.java.

◆ subtract() [1/2]

abstract Duration org.omg.dds.core.Duration.subtract ( Duration duration )

abstract

Returns: a new Duration that is the difference after subtracting the given Duration.

◆ subtract() [2/2]

abstract Duration org.omg.dds.core.Duration.subtract	(	long	duration,
		TimeUnit	unit
	)

abstract

Returns: a new Duration that is the difference after subtracting the given Duration.

◆ zeroDuration()

static Duration org.omg.dds.core.Duration.zeroDuration ( ServiceEnvironment env )

static

Parameters

env	Identifies the Service instance to which the object will belong.

Returns: A org.omg.dds.core.Duration of zero length.

Definition at line 97 of file Duration.java.

The documentation for this class was generated from the following file:

java5/common/java/code/org/omg/dds/core/Duration.java

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ getDuration()

◆ getEnvironment()

◆ getRemainder()

◆ infiniteDuration()

◆ isInfinite()

◆ isZero()

◆ newDuration()

◆ subtract() [1/2]

◆ subtract() [2/2]

◆ zeroDuration()