org.lsst.ccs.subsystem.shutter.common

Interface TimeOrdered

All Superinterfaces:

Comparable<TimeOrdered>

All Known Implementing Classes:

EncoderSample, HallTransition, PredictedPosition

public interface TimeOrdered
extends Comparable<TimeOrdered>

For objects that have a natural time ordering using CCS timestamps.

Author:

tether

Method Summary

Modifier and Type	Method and Description
default int	compareTo(TimeOrdered other)
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getTime()
default Duration	timeDiff(org.lsst.ccs.utilities.taitime.CCSTimeStamp ref) Calculates the time difference between this.getTime() and a reference timestamp.
default Duration	timeDiff(TimeOrdered ref) Calculates the time difference between this.getTime() and a reference TimeOrdered object.

Method Detail

getTime

org.lsst.ccs.utilities.taitime.CCSTimeStamp getTime()

compareTo

default int compareTo(TimeOrdered other)

Specified by:

compareTo in interface Comparable<TimeOrdered>

timeDiff

default Duration timeDiff(org.lsst.ccs.utilities.taitime.CCSTimeStamp ref)

Calculates the time difference between this.getTime() and a reference timestamp.

Parameters:

ref - The reference timestamp.

Returns:

The time difference as a Duration (may be negative or zero).

timeDiff

default Duration timeDiff(TimeOrdered ref)

Calculates the time difference between this.getTime() and a reference TimeOrdered object.

Parameters:

ref - The object whose time is used as a reference..

Returns:

The time difference as a Duration (may be negative or zero).