Package org.yamcs.http.api

Class TimeCorrelationApi

java.lang.Object

org.yamcs.protobuf.AbstractTimeCorrelationApi<Context>

org.yamcs.http.api.TimeCorrelationApi

All Implemented Interfaces:

Api<Context>

public class TimeCorrelationApi
extends AbstractTimeCorrelationApi<Context>

Constructor Summary

Constructors

Constructor	Description
TimeCorrelationApi()

Method Summary

Modifier and Type	Method	Description
void	addTimeOfFlightIntervals(Context ctx, AddTimeOfFlightIntervalsRequest request, Observer<com.google.protobuf.Empty> observer)	Add intervals for the time of flight calculation.
void	deleteTimeOfFlightIntervals(Context ctx, DeleteTimeOfFlightIntervalsRequest request, Observer<com.google.protobuf.Empty> observer)	Delete intervals for the time of flight calculation.
void	getConfig(Context ctx, GetTcoConfigRequest request, Observer<TcoConfig> observer)	Get the TCO config Returns the TCO configuration comprising the accuracy, validity and the fixed delays.
void	getStatus(Context 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.
void	reset(Context ctx, TcoResetRequest request, Observer<com.google.protobuf.Empty> observer)	Reset the time correlation.
void	setCoefficients(Context ctx, SetCoefficientsRequest request, Observer<com.google.protobuf.Empty> observer)	Set the TCO coefficients Manually set the coefficients to be used for time correlation.
void	setConfig(Context ctx, SetTcoConfigRequest request, Observer<com.google.protobuf.Empty> observer)	Set the TCO config Set the TCO configuration.

Methods inherited from class org.yamcs.protobuf.AbstractTimeCorrelationApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TimeCorrelationApi

public TimeCorrelationApi()

Method Details

getConfig

public void getConfig(Context ctx,
 GetTcoConfigRequest request,
 Observer<TcoConfig> observer)

Description copied from class: AbstractTimeCorrelationApi

  Get the TCO config
 
  Returns the TCO configuration comprising the accuracy, validity and the fixed delays.
 

Specified by:

getConfig in class AbstractTimeCorrelationApi<Context>

setConfig

public void setConfig(Context ctx,
 SetTcoConfigRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractTimeCorrelationApi

  Set the TCO config
 
  Set the TCO configuration. The configuration is not persisted on disk.
 

Specified by:

setConfig in class AbstractTimeCorrelationApi<Context>

getStatus

public void getStatus(Context ctx,
 GetTcoStatusRequest request,
 Observer<TcoStatus> observer)

Description copied from class: AbstractTimeCorrelationApi

  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<Context>

setCoefficients

public void setCoefficients(Context ctx,
 SetCoefficientsRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractTimeCorrelationApi

  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<Context>

reset

public void reset(Context ctx,
 TcoResetRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractTimeCorrelationApi

 Reset the time correlation.
 
 The current used TCO coefficients are removed together with all collected samples.
 

Specified by:

reset in class AbstractTimeCorrelationApi<Context>

addTimeOfFlightIntervals

public void addTimeOfFlightIntervals(Context ctx,
 AddTimeOfFlightIntervalsRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractTimeCorrelationApi

  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<Context>

deleteTimeOfFlightIntervals

public void deleteTimeOfFlightIntervals(Context ctx,
 DeleteTimeOfFlightIntervalsRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractTimeCorrelationApi

  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<Context>