javax.realtime

Class RealtimeClock

java.lang.Object

javax.realtime.Clock

javax.realtime.RealtimeClock

public class RealtimeClock
extends Clock

A RealtimeClock implementation.

Version:

1.2; - December 2013

Author:

Anders P. Ravn, Aalborg University, apr@cs.aau.dk,
Hans Søndergaard, VIA University College, Denmark, hso@via.dk

Method Summary

Methods

Modifier and Type	Method and Description
RelativeTime	getEpochOffset() Returns the relative time of the offset of the epoch of this clock from the Epoch of the RealtimeClock.
RelativeTime	getResolution() Returns a newly allocated RelativeTime object that indicates the nominal interval between ticks.
RelativeTime	getResolution(RelativeTime dest) Gets the resolution of the clock, the nominal interval between ticks and stores the result in dest.
AbsoluteTime	getTime() Creates a new object representing now of this clock.
AbsoluteTime	getTime(AbsoluteTime dest) Stores now of this clock in dest.

Methods inherited from class javax.realtime.Clock

getRealtimeClock

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEpochOffset

public RelativeTime getEpochOffset()

Description copied from class: Clock

Returns the relative time of the offset of the epoch of this clock from the Epoch of the RealtimeClock.

Specified by:

getEpochOffset in class Clock

Returns:

the offset of this clock epoch from the RealtimeClock. The returned object is associated with this clock.

getResolution

public RelativeTime getResolution()

Returns a newly allocated RelativeTime object that indicates the nominal interval between ticks. The return value shall be associated with this clock. All relative time differences measured by this clock are approximately an integral multiple of the resolution.

Specified by:

getResolution in class Clock

Returns:

clock resolution.

getResolution

public RelativeTime getResolution(RelativeTime dest)

Description copied from class: Clock

Gets the resolution of the clock, the nominal interval between ticks and stores the result in dest.

Specified by:

getResolution in class Clock

Parameters:

dest - if dest is null, allocate a new RelativeTime instance to hold the returned value.

Returns:

if dest is not null, it is set to the resolution object of this. Otherwise a newly allocated object is returned. The returned object is associated with this clock.

getTime

public AbsoluteTime getTime()

Description copied from class: Clock

Creates a new object representing now of this clock.

Specified by:

getTime in class Clock

Returns:

A new AbsoluteTime object whose time is now of this clock.

getTime

public AbsoluteTime getTime(AbsoluteTime dest)

Description copied from class: Clock

Stores now of this clock in dest.

Specified by:

getTime in class Clock

Parameters:

dest - If dest is null, allocate a new AbsoluteTime instance to hold the returned value.

Returns:

The resulting value.