Package org.orekit.time.clocks

Class ClockOffset

java.lang.Object
org.orekit.time.clocks.ClockOffset
All Implemented Interfaces:
TimeStamped
public class ClockOffset extends Object implements TimeStamped
Container for time stamped clock offset.

Instances of this class are immutable

Since:
12.1
Author:
Luc Maisonobe

  • Constructor Details

    • ClockOffset

      public ClockOffset(AbsoluteDate date, double bias, double rate, double acceleration)
      Simple constructor.
      Parameters:
      date - date
      bias - clock bias
      rate - clock rate (can be set to Double.NaN if unknown)
      acceleration - clock acceleration (can be set to Double.NaN if unknown)

    • ClockOffset

      public ClockOffset(AbsoluteDate date, double[] terms)
      Simple constructor.
      Parameters:
      date - date
      terms - the clock terms, up to 3 values for bias, drift, and acceleration

  • Method Details

    • add

      public ClockOffset add(ClockOffset other)
      Add another offset to the instance.

      The instance is not modified, a new instance is created

      Parameters:
      other - offset to add (date part will be ignored)
      Returns:
      instance + other, at instance date
      Since:
      14.0

    • subtract

      public ClockOffset subtract(ClockOffset other)
      Subtract another offset from the instance.

      The instance is not modified, a new instance is created

      Parameters:
      other - offset to subtract (date part will be ignored)
      Returns:
      instance - other, at instance date
      Since:
      14.0

    • getDate

      public AbsoluteDate getDate()
      Get the date.
      Specified by:
      getDate in interface TimeStamped
      Returns:
      date attached to the object

    • getBias

      public double getBias()
      Get bias.
      Returns:
      bias
      Since:
      14.0

    • getRate

      public double getRate()
      Get rate.
      Returns:
      rate (Double.NaN if unknown)

    • getAcceleration

      public double getAcceleration()
      Get acceleration.
      Returns:
      acceleration (Double.NaN if unknown)

    • getValue

      public double getValue(AbsoluteDate givenDate)
      Get the value of the clock offset at a given time.
      Parameters:
      givenDate - the date at which to evaluate the clock offset
      Returns:
      The value of the clock in seconds from the given date