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.

RTSJ V1.0.1 class RationalTime is deprecated

public class RationalTime
extends RelativeTime

Jamaica Real-Time Specification for Java class RationalTime

Constructor Summary

Constructors

Constructor and Description
RationalTime(int frequency) Deprecated. RTSJ V1.0.1 class RationalTime is deprecated
RationalTime(int frequency, long millis, int nanos) Deprecated. RTSJ V1.0.1 class RationalTime is deprecated
RationalTime(int frequency, RelativeTime interval) Deprecated. RTSJ V1.0.1 class RationalTime is deprecated

Method Summary

Modifier and Type	Method and Description
AbsoluteTime	absolute(Clock clock, AbsoluteTime destination) Deprecated. RTSJ V1.0.1 class RationalTime is deprecated
void	addInterarrivalTo(AbsoluteTime destination) Deprecated. RTSJ V1.0.1 this method is only required to support the deprecated RationalTime.
int	getFrequency() Deprecated. RTSJ V1.0.1 class RationalTime is deprecated
RelativeTime	getInterarrivalTime() Deprecated. RTSJ V1.0.1 this method is only required to support the deprecated RationalTime.
RelativeTime	getInterarrivalTime(RelativeTime dest) Deprecated. RTSJ V1.0.1 this method is only required to support the deprecated RationalTime.
RationalTime	set(long millis, int nanos) Deprecated. Sets the value of the frequency field.
RelativeTime	set(RelativeTime time) Deprecated. Changes the value represented by this to that of the given time.
void	setFrequency(int frequency) Deprecated. RTSJ V1.0.1 class RationalTime is deprecated
java.lang.String	toString() Deprecated. toString returns this interval as a string of the form "(<milli> ms, <nano> ns)".

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, waitForObject

Methods inherited from class java.lang.Object

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

Constructor Detail

RationalTime

public RationalTime(int frequency)
             throws java.lang.IllegalArgumentException

Deprecated. RTSJ V1.0.1 class RationalTime is deprecated

Constructor to create a rational time with the given frequency per second. Equivalent to RationalTime(frequency, 1000, 0);

Parameters:

frequency - the frequency.

Throws:

java.lang.IllegalArgumentException - iff frequency is negative.

RationalTime

public RationalTime(int frequency,
                    long millis,
                    int nanos)
             throws java.lang.IllegalArgumentException

Deprecated. RTSJ V1.0.1 class RationalTime is deprecated

Constructor to create an instance of RationalTime with the given frequency per given base interval.

Parameters:

frequency - the frequency.

millis - milliseconds of base interval.

nanos - nanoseconds of base interval.

Throws:

java.lang.IllegalArgumentException - iff any argument is negative or the frequency is 0.

RationalTime

public RationalTime(int frequency,
                    RelativeTime interval)
             throws java.lang.IllegalArgumentException

Deprecated. RTSJ V1.0.1 class RationalTime is deprecated

Constructor for a rational time with the given frequency and base interval.

Parameters:

frequency - the frequency.

interval - the base interval.

Throws:

java.lang.IllegalArgumentException - iff frequency is negative or the base interval is null.

Method Detail

absolute

public AbsoluteTime absolute(Clock clock,
                             AbsoluteTime destination)

Deprecated. RTSJ V1.0.1 class RationalTime is deprecated

absolute converts this rational time into an instance of absolute time for the point in time given by the current time of the given clock.

Overrides:

absolute in class RelativeTime

Parameters:

clock - The clock, null to use Clock.getRealtimeClock().

destination - the destination absolute time object.

Returns:

destination or a new absolute time object.

Throws:

java.lang.ArithmeticException - if the resulting absolute time could not be represented by an instance of AbsoluteTime.

addInterarrivalTo

public void addInterarrivalTo(AbsoluteTime destination)

Deprecated. RTSJ V1.0.1 this method is only required to support the deprecated RationalTime.

addInterarrivalTo adds this to the given absolute time.

Overrides:

addInterarrivalTo in class RelativeTime

Parameters:

destination -

getFrequency

public int getFrequency()

Deprecated. RTSJ V1.0.1 class RationalTime is deprecated

getFrequency returns the frequency per base interval.

Returns:

the frequency.

getInterarrivalTime

public RelativeTime getInterarrivalTime(RelativeTime dest)

Deprecated. RTSJ V1.0.1 this method is only required to support the deprecated RationalTime.

getInterarrivalTime returns the interval defined by this. If this is RationalTime, this is the interval divided by the frequency.

Overrides:

getInterarrivalTime in class RelativeTime

Parameters:

dest - The preallocated RelativeTime object to hold the result. May be null to indicate that a new object should be allocated.

Returns:

dest when dest != null, otherwise a newly allocated instance.

getInterarrivalTime

public RelativeTime getInterarrivalTime()

Deprecated. RTSJ V1.0.1 this method is only required to support the deprecated RationalTime.

getInterarrivalTime returns the interval defined by this. If this is RationalTime, this is the interval divided by the frequency.

Overrides:

getInterarrivalTime in class RelativeTime

Returns:

a newly allocated instance of RelativeTime.

set

public RelativeTime set(RelativeTime time)

Deprecated.

Changes the value represented by this to that of the given time. The Chronograph associated with this is set to be the Chronograph associated with the time parameter.

Overrides:

set in class HighResolutionTime<RelativeTime>

Parameters:

time - The new value of this

Returns:

this

Throws:

java.lang.ClassCastException - when the type of this and the type of the parameter time are not the same.

StaticIllegalArgumentException - when the parameter time is null.

Since:

RTSJ 2.0 returns itself

set

public RationalTime set(long millis,
                        int nanos)
                 throws java.lang.IllegalArgumentException

Deprecated.

Sets the value of the frequency field.

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

Throws:

StaticIllegalArgumentException - when there is an overflow in the millisecond component while normalizing. result of parameter normalization.

java.lang.IllegalArgumentException

Since:

RTSJ 2.0 returns itself

setFrequency

public void setFrequency(int frequency)
                  throws java.lang.ArithmeticException

Deprecated. RTSJ V1.0.1 class RationalTime is deprecated

Sets the frequency to the gien value.

Parameters:

frequency - the new frequency.

Throws:

java.lang.ArithmeticException

toString

public java.lang.String toString()

Deprecated.

toString returns this interval as a string of the form "(<milli> ms, <nano> ns)".

Overrides:

toString in class RelativeTime

Returns:

the String representation