Module org.yamcs.api
Package org.yamcs.protobuf

Class TimeCorrelationApiClient

java.lang.Object
org.yamcs.protobuf.AbstractTimeCorrelationApi<Void>
org.yamcs.protobuf.TimeCorrelationApiClient
All Implemented Interfaces:
Api<Void>
public class TimeCorrelationApiClient extends AbstractTimeCorrelationApi<Void>
 Methods related to the Time Correlation Service.

  • Constructor Details

    • TimeCorrelationApiClient

      public TimeCorrelationApiClient(MethodHandler handler)

  • Method Details

    • getConfig

      public final void getConfig(Void ctx, GetTcoConfigRequest request, Observer<TcoConfig> observer)
        Get the TCO config
 
  Returns the TCO configuration comprising the accuracy, validity and the fixed delays.
      Specified by:
      getConfig in class AbstractTimeCorrelationApi<Void>

    • setConfig

      public final void setConfig(Void ctx, SetTcoConfigRequest request, Observer<com.google.protobuf.Empty> observer)
        Set the TCO config
 
  Set the TCO configuration. The configuration is not persisted on disk.
      Specified by:
      setConfig in class AbstractTimeCorrelationApi<Void>

    • getStatus

      public final void getStatus(Void ctx, GetTcoStatusRequest request, Observer<TcoStatus> observer)
        Get the TCO status
 
  Returns the TCO status comprising the currently used coefficients, the last computed deviation
  and the last received samples.
      Specified by:
      getStatus in class AbstractTimeCorrelationApi<Void>

    • setCoefficients

      public final void setCoefficients(Void ctx, SetCoefficientsRequest request, Observer<com.google.protobuf.Empty> observer)
        Set the TCO coefficients
 
 Manually set the coefficients to be used for time correlation. These will overwrite 
  the automatic computed coefficients.
      Specified by:
      setCoefficients in class AbstractTimeCorrelationApi<Void>

    • reset

      public final void reset(Void ctx, TcoResetRequest request, Observer<com.google.protobuf.Empty> observer)
       Reset the time correlation.
 
 The current used TCO coefficients are removed together with all collected samples.
      Specified by:
      reset in class AbstractTimeCorrelationApi<Void>

    • addTimeOfFlightIntervals

      public final void addTimeOfFlightIntervals(Void ctx, AddTimeOfFlightIntervalsRequest request, Observer<com.google.protobuf.Empty> observer)
        Add intervals for the time of flight calculation.
 
  Each ``[ertStart, ertStop)`` interval contains a polynomial function used to compute the time of flight for the given ``ert``.
  The intervals can overlap and are sorted in descending order of the start time.
  The first (highest start time) interval where the requested ert fits, will be used for the calculation. 
  
  The formula used for calculating the time of flight for a frame/packet received
  at ``ert`` in the ``[ertStart, ertStop)`` interval is:
  
      ``delta = ert - ertStart``
 
      ``tof = polCoef[0] + polCoef[1] * delta + polCoef[2] * delta^2 + ...``
  
  The result of the polynomial is the ``tof`` expressed in seconds.
      Specified by:
      addTimeOfFlightIntervals in class AbstractTimeCorrelationApi<Void>

    • deleteTimeOfFlightIntervals

      public final void deleteTimeOfFlightIntervals(Void ctx, DeleteTimeOfFlightIntervalsRequest request, Observer<com.google.protobuf.Empty> observer)
        Delete intervals for the time of flight calculation.
 
  All the intervals with the start time
  falling in the requested [start, stop] interval will be removed.
      Specified by:
      deleteTimeOfFlightIntervals in class AbstractTimeCorrelationApi<Void>