Module hla.rti1516e

Package hla.rti1516e.time

Interface HLAinteger64Time

All Superinterfaces:

Comparable<HLAinteger64Time>, LogicalTime<HLAinteger64Time,HLAinteger64Interval>, Serializable

public interface HLAinteger64Time
extends LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Interface for the time part of the standardized time type HLAinteger64Time.

Method Summary

Modifier and Type	Method	Description
HLAinteger64Time	add(HLAinteger64Interval val)	Returns a LogicalTime whose value is (this + val).
int	compareTo(HLAinteger64Time other)	Compares this object with the specified object for order.
HLAinteger64Interval	distance(HLAinteger64Time val)	Returns a LogicalTimeInterval whose value is the time interval between this and val.
void	encode(byte[] buffer, int offset)	Encodes this object in the specified buffer starting at the specified offset.
int	encodedLength()	Returns the size of the buffer required to encode this object.
long	getValue()
boolean	isFinal()	Returns true is this time is equal to the final time.
boolean	isInitial()	Returns true is this time is equal to the initial time.
HLAinteger64Time	subtract(HLAinteger64Interval val)	Returns a LogicalTime whose value is (this - val).

Methods inherited from interface hla.rti1516e.LogicalTime

equals, hashCode, toString

Method Details

isInitial

boolean isInitial()

Description copied from interface: LogicalTime

Returns true is this time is equal to the initial time.

Specified by:

isInitial in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Returns:

true if initial value.

isFinal

boolean isFinal()

Description copied from interface: LogicalTime

Returns true is this time is equal to the final time.

Specified by:

isFinal in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Returns:

true if final value.

add

HLAinteger64Time add(HLAinteger64Interval val)
              throws IllegalTimeArithmetic

Description copied from interface: LogicalTime

Returns a LogicalTime whose value is (this + val). The returned value shall be different from this value if the specified interval != 0.

Specified by:

add in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Parameters:

val - interval to add.

Returns:

new time value.

Throws:

IllegalTimeArithmetic

subtract

HLAinteger64Time subtract(HLAinteger64Interval val)
                   throws IllegalTimeArithmetic

Description copied from interface: LogicalTime

Returns a LogicalTime whose value is (this - val). The returned value shall be different from this value if the specified interval != 0.

Specified by:

subtract in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Parameters:

val - interval to subtract.

Returns:

new time value.

Throws:

IllegalTimeArithmetic

distance

HLAinteger64Interval distance(HLAinteger64Time val)

Description copied from interface: LogicalTime

Returns a LogicalTimeInterval whose value is the time interval between this and val.

Specified by:

distance in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Parameters:

val - other time.

Returns:

distance between times.

compareTo

int compareTo(HLAinteger64Time other)

Description copied from interface: LogicalTime

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable<HLAinteger64Time>

Specified by:

compareTo in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Parameters:

other - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

encodedLength

int encodedLength()

Description copied from interface: LogicalTime

Returns the size of the buffer required to encode this object.

Specified by:

encodedLength in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Returns:

size of buffer.

encode

void encode(byte[] buffer,
 int offset)
     throws CouldNotEncode

Description copied from interface: LogicalTime

Encodes this object in the specified buffer starting at the specified offset.

Specified by:

encode in interface LogicalTime<HLAinteger64Time,HLAinteger64Interval>

Parameters:

buffer - the buffer to encode into.

offset - the offset where to start encoding.

Throws:

CouldNotEncode

getValue

long getValue()