javax.safetycritical

Class AbsoluteTime

java.lang.Object

javax.safetycritical.HighResolutionTime

javax.safetycritical.AbsoluteTime

All Implemented Interfaces:

java.lang.Comparable

@SCJAllowed
public class AbsoluteTime
extends HighResolutionTime

An object that represents a specific point in time given by milliseconds plus nanoseconds past some point in time, an Epoch, fixed by the clock.
The default clock is the default real-time clock.
A time object in normalized form represents negative time if both components are nonzero and negative, or one is nonzero and negative and the other is zero.
For add and subtract operations, negative values behave as they do in Java arithmetic.

Version:

1.0; - May 2012

Author:

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

Relative_to_SCJ_Draft_Version_0.79:

- semantic issue: Java arithmetic is assumed for numeric values
- semantic issue: The clock of RelativeTime in add and subtract is ignored (RTSJ throws an exception)
- semantic issue: If RelativeTime time in add is null, an IllegalArgumentException is thrown
- semantic issue: If AbsoluteTime time in subtract is null, an IllegalArgumentException is thrown
- semantic issue: If clocks are different in AbsoluteTime subtract, an IllegalArgumentException is thrown.

Constructor Summary

Constructors

Constructor and Description
AbsoluteTime(AbsoluteTime time) Makes a new object that is a copy from the parameter time.
AbsoluteTime(Clock clock) Equivalent to AbsoluteTime(0,0,clock).
AbsoluteTime(long millis, int nanos) Constructs an AbsoluteTime object with time millisecond and nanosecond components past the real-time clock's Epoch.
AbsoluteTime(long millis, int nanos, Clock clock) Constructs an AbsoluteTime object with time millisecond and nanosecond components past the clock's Epoch.

Method Summary

Methods

Modifier and Type	Method and Description
AbsoluteTime	add(long millis, int nanos) Creates a new object representing the result of adding millis and nanos to the values from this and normalizing the result.
AbsoluteTime	add(long millis, int nanos, AbsoluteTime dest) Returns an object containing the value resulting from adding millis and nanos to the values from this and normalizing the result.
AbsoluteTime	add(RelativeTime time) Creates a new instance of AbsoluteTime representing the result of adding time to the value of this and normalizing the result.
AbsoluteTime	add(RelativeTime time, AbsoluteTime dest) Returns an object containing the value resulting from adding time to the value of this and normalizing the result.
RelativeTime	subtract(AbsoluteTime time) Creates a new instance of RelativeTime representing the result of subtracting time from the value of this and normalizing the result.
RelativeTime	subtract(AbsoluteTime time, RelativeTime dest) Returns an object containing the value resulting from subtracting time from the value of this and normalizing the result.
AbsoluteTime	subtract(RelativeTime time) Creates a new instance of AbsoluteTime representing the result of subtracting time from the value of this and normalizing the result.
AbsoluteTime	subtract(RelativeTime time, AbsoluteTime dest) Returns an object containing the value resulting from subtracting time from the value of this and normalizing the result.

Methods inherited from class javax.safetycritical.HighResolutionTime

compareTo, compareTo, equals, getClock, getMilliseconds, getNanoseconds, set, set, set, toString, waitForObject

Methods inherited from class java.lang.Object

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

Constructor Detail

AbsoluteTime

public AbsoluteTime(long millis,
            int nanos)

Constructs an AbsoluteTime object with time millisecond and nanosecond components past the real-time clock's Epoch.
The actual value is the result of parameter normalization.

Parameters:

millis - is the desired value for the millisecond component

nanos - is the desired value for the nanosecond component.

AbsoluteTime

public AbsoluteTime(AbsoluteTime time)

Makes a new object that is a copy from the parameter time.

Parameters:

time - the object copied

AbsoluteTime

public AbsoluteTime(long millis,
            int nanos,
            Clock clock)

Constructs an AbsoluteTime object with time millisecond and nanosecond components past the clock's Epoch.

Parameters:

millis - is the desired value for the millisecond component

nanos - is the desired value for the nanosecond component.

clock - is the desired value for the clock

AbsoluteTime

public AbsoluteTime(Clock clock)

Equivalent to AbsoluteTime(0,0,clock).

Parameters:

clock - is the desired value for the clock

Method Detail

add

public AbsoluteTime add(long millis,
               int nanos)

Creates a new object representing the result of adding millis and nanos to the values from this and normalizing the result.

Parameters:

millis - is the number of milliseconds to be added to this.

nanos - is the number of nanoseconds to be added to this.

Returns:

a new AbsoluteTime object whose time is the normalization of this plus millis and nanos.

add

public AbsoluteTime add(long millis,
               int nanos,
               AbsoluteTime dest)

Returns an object containing the value resulting from adding millis and nanos to the values from this and normalizing the result.
The result is placed in dest.

Parameters:

millis - is he number of milliseconds to be added to this.

nanos - is the number of nanoseconds to be added to this.

dest - if null a new dest object is created, the result is placed there and returned.

Returns:

the dest object

add

public AbsoluteTime add(RelativeTime time)

Creates a new instance of AbsoluteTime representing the result of adding time to the value of this and normalizing the result.

Parameters:

time - the time to add to this.

Returns:

a new object whose time is the normalization of this plus the parameter time.

add

public AbsoluteTime add(RelativeTime time,
               AbsoluteTime dest)

Returns an object containing the value resulting from adding time to the value of this and normalizing the result. The result is placed in dest.

Parameters:

time - is the time to add to this

dest - if null a new dest object is created, the result is placed there and returned.

Returns:

the dest object

subtract

public RelativeTime subtract(AbsoluteTime time)

Creates a new instance of RelativeTime representing the result of subtracting time from the value of this and normalizing the result.

Parameters:

time - is the time to subtract from this.

Returns:

a new object whose time is the normalization of this minus time.

subtract

public RelativeTime subtract(AbsoluteTime time,
                    RelativeTime dest)

Returns an object containing the value resulting from subtracting time from the value of this and normalizing the result. The result is placed in dest.

Parameters:

time - is the time to subtract from this.

dest - if null a new dest object is created, the result is placed there and returned.

Returns:

the dest object

subtract

public AbsoluteTime subtract(RelativeTime time)

Creates a new instance of AbsoluteTime representing the result of subtracting time from the value of this and normalizing the result.

Parameters:

time - is the time to subtract from this.

Returns:

a new AbsoluteTime object whose time is the normalization of this minus time.

subtract

public AbsoluteTime subtract(RelativeTime time,
                    AbsoluteTime dest)

Returns an object containing the value resulting from subtracting time from the value of this and normalizing the result. The result is placed in dest.

Parameters:

time - is the time to subtract from to this

dest - if null a new dest object is created, the result is placed there and returned.

Returns:

the dest object