Module org.yamcs.sle

Package org.yamcs.sle

Class SleApi

java.lang.Object

org.yamcs.sle.api.AbstractSleApi<Context>

org.yamcs.sle.SleApi

All Implemented Interfaces:

Api<Context>

public class SleApi
extends AbstractSleApi<Context>

Constructor Summary

Constructors

Constructor	Description
SleApi()

Method Summary

Modifier and Type	Method	Description
void	cltuThrowEvent(Context ctx, CltuThrowEventRequest request, Observer<CltuThrowEventResponse> observer)	Invoke a CLTU Throw Event.
void	getParameter(Context ctx, GetParameterRequest request, Observer<GetParameterResponse> observer)	Invoke a SLE Get Parameter.
void	requestOfflineData(Context ctx, RequestOfflineDataRequest request, Observer<com.google.protobuf.Empty> observer)	Request offline data.
static YamcsServerInstance	verifyInstanceObj(String instance)

Methods inherited from class org.yamcs.sle.api.AbstractSleApi

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

SleApi

public SleApi()

Method Details

requestOfflineData

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

Description copied from class: AbstractSleApi

  Request offline data.
 
  This request can be used to obtain offline data from an SLE provider. The
  link has to be of type ``org.yamcs.sle.OfflineTmSleLink``.
 
  ``start`` and ``stop`` are passed as parameters to the RAF-START SLE
  request. The SLE provider will deliver all frames having their Earth
  Reception Time (ERT) in the [start, stop] time interval, both ends are
  inclusive. SLE requires that start is strictly smaller than stop so
  ``start=stop`` is not accepted.
 
  The time passed via API is at nanosecond resolution whereas the time passed
  in the RAF-START SLE request is at microsecond or picosecond resolution
  (depending on the SLE version used).
 
 
  .. rubric:: Leap seconds
 
  Time passed via the API is according to
  the `Timestamp <https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp>`_
  protobuf message and is passed *unsmeared* to the SLE request. This is
  different from the normal requests to Yamcs where the time is transformed
  into internal Yamcs time (but at millisecond resolution!) by performing
  reverse smearing around the leap seconds.
 
  This means that it is not possible to specify a retrieval that starts or
  stops on a leap second. For example ``2016-12-31T23:59:60Z`` will be
  effectively translated into ``2017-01-01T00:00:00Z``.
 

Specified by:

requestOfflineData in class AbstractSleApi<Context>

verifyInstanceObj

public static YamcsServerInstance verifyInstanceObj(String instance)

cltuThrowEvent

public void cltuThrowEvent(Context ctx,
 CltuThrowEventRequest request,
 Observer<CltuThrowEventResponse> observer)

Description copied from class: AbstractSleApi

  Invoke a CLTU Throw Event.
 
  The link has to be of type ``org.yamcs.sle.OfflineTmSleLink``.
 

Specified by:

cltuThrowEvent in class AbstractSleApi<Context>

getParameter

public void getParameter(Context ctx,
 GetParameterRequest request,
 Observer<GetParameterResponse> observer)

Description copied from class: AbstractSleApi

  Invoke a SLE Get Parameter.
 
  Can be used for all SLE links but some parameters make sense only for certain links.
 

Specified by:

getParameter in class AbstractSleApi<Context>