Package org.yamcs.http.api
Class TimeCorrelationApi
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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
-
Constructor Details
-
TimeCorrelationApi
public TimeCorrelationApi()
-
-
Method Details
-
getConfig
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 classAbstractTimeCorrelationApi<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 classAbstractTimeCorrelationApi<Context>
-
getStatus
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 classAbstractTimeCorrelationApi<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 classAbstractTimeCorrelationApi<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 classAbstractTimeCorrelationApi<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 classAbstractTimeCorrelationApi<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 classAbstractTimeCorrelationApi<Context>
-