javax.realtime

Class RationalTime

java.lang.Object

javax.realtime.HighResolutionTime<RelativeTime>

javax.realtime.RelativeTime

javax.realtime.RationalTime

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<RelativeTime>

Deprecated.

as of RTSJ 1.0.1

@Deprecated
public class RationalTime
extends RelativeTime

An object that represents a time interval milliseconds/10³ + nanoseconds/10⁹ seconds long that is divided into subintervals by some frequency. This is generally used in periodic events, threads, and feasibility analysis to specify periods where there is a basic period that must be adhered to strictly (the interval), but within that interval the periodic events are supposed to happen frequency times, as uniformly spaced as possible, but clock and scheduling jitter is moderately acceptable.

Caution: This class is explicitly unsafe for multithreading when being changed. Code that mutates instances of this class should synchronize at a higher level.

Constructor Summary

Constructors

Constructor and Description
RationalTime(int frequency) Deprecated. Constructs an instance of RationalTime.
RationalTime(int frequency, long millis, int nanos) Deprecated. Constructs an instance of RationalTime.
RationalTime(int frequency, RelativeTime interval) Deprecated. Constructs an instance of RationalTime from the given RelativeTime.

Method Summary

Modifier and Type	Method and Description
AbsoluteTime	absolute(Clock clock, AbsoluteTime destination) Deprecated. Converts time of this to an absolute time.
void	addInterarrivalTo(AbsoluteTime destination) Deprecated. Adds the time of this to an AbsoluteTime It is almost the same dest.add(this, dest) except that it accounts for (i.e.
int	getFrequency() Deprecated. Gets the value of frequency.
RelativeTime	getInterarrivalTime() Deprecated. Gets the interarrival time.
RelativeTime	getInterarrivalTime(RelativeTime dest) Deprecated. Gets the interarrival time.
RationalTime	set(long millis, int nanos) Deprecated. Sets the indicated fields to the given values.
void	setFrequency(int frequency) Deprecated. Sets the value of the frequency field.
java.lang.String	toString() Deprecated. Creates a printable string of the time given by this.

Methods inherited from class javax.realtime.RelativeTime

absolute, absolute, absolute, add, add, add, add, apportion, apportion, compareToZero, multiply, negate, negate, relative, relative, relative, relative, scale, scale, subtract, subtract

Methods inherited from class javax.realtime.HighResolutionTime

clone, compareTo, equals, equals, getChronograph, getClock, getMilliseconds, getNanoseconds, hashCode, set, set, set, waitForObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RationalTime

public RationalTime(int frequency,
                    long millis,
                    int nanos)

Deprecated.

Constructs an instance of RationalTime. All arguments must be greater than or equal to zero.

Parameters:

frequency - The frequency value.

millis - The milliseconds value.

nanos - The nanoseconds value.

Throws:

java.lang.IllegalArgumentException - when any of the argument values are less than zero, or when frequency is equal to zero.

RationalTime

public RationalTime(int frequency,
                    RelativeTime interval)

Deprecated.

Constructs an instance of RationalTime from the given RelativeTime.

Parameters:

frequency - The frequency value.

interval - The given instance of RelativeTime.

Throws:

java.lang.IllegalArgumentException - when either of the argument values are less than zero, or when frequency is equal to zero.

RationalTime

public RationalTime(int frequency)

Deprecated.

Constructs an instance of RationalTime. Equivalent to new RationalTime(1000, 0, frequency)—essentially a cycles-per-second value.

Throws:

java.lang.IllegalArgumentException - when frequency is less than or equal to zero.

Method Detail

absolute

public AbsoluteTime absolute(Clock clock,
                             AbsoluteTime destination)

Deprecated.

Converts time of this to an absolute time.

Overrides:

absolute in class RelativeTime

Parameters:

clock - The reference clock. When null, Clock.getRealTimeClock() is used.

destination - A reference to the destination instance.

Returns:

the AbsoluteTime conversion in dest when dest is not null, otherwise the result is returned in a newly allocated object. The result is associated with the clock parameter.

addInterarrivalTo

public void addInterarrivalTo(AbsoluteTime destination)

Deprecated.

Adds the time of this to an AbsoluteTime It is almost the same dest.add(this, dest) except that it accounts for (i.e. divides by) the frequency.

Overrides:

addInterarrivalTo in class RelativeTime

Parameters:

destination - A reference to the destination instance.

getFrequency

public int getFrequency()

Deprecated.

Gets the value of frequency.

Returns:

The value of frequency as an integer.

getInterarrivalTime

public RelativeTime getInterarrivalTime()

Deprecated.

Gets the interarrival time. This time is (milliseconds/103 + nanoseconds/109)/frequency rounded down to the nearest expressible value of the fields and their types of RelativeTime.

Overrides:

getInterarrivalTime in class RelativeTime

getInterarrivalTime

public RelativeTime getInterarrivalTime(RelativeTime dest)

Deprecated.

Gets the interarrival time. This time is (milliseconds / 10<sup>3</sup> + nanoseconds / 10<sup>9</sup>) / frequency rounded down to the nearest expressible value of the fields and their types of RelativeTime.

Overrides:

getInterarrivalTime in class RelativeTime

Parameters:

dest - Result is stored in dest and returned, when null, a new object is returned.

set

public RationalTime set(long millis,
                        int nanos)

Deprecated.

Sets the indicated fields to the given values.

Overrides:

set in class HighResolutionTime<RelativeTime>

Parameters:

millis - The new value for the millisecond field.

nanos - The new value for the nanosecond field.

Returns:

this

Since:

RTSJ 2.0 returns itself

setFrequency

public void setFrequency(int frequency)

Deprecated.

Sets the value of the frequency field.

Parameters:

frequency - The new value for the frequency.

Throws:

java.lang.IllegalArgumentException - when frequency is less than or equal to zero.

toString

public java.lang.String toString()

Deprecated.

Creates a printable string of the time given by this.

The string shall be a decimal representation of the frequency, milliseconds and nanosecond values; formatted as follows "(100, 2251 ms, 750000 ns)"

Overrides:

toString in class RelativeTime

Returns:

a string object converted from the time given by this.