Package org.yamcs.http.api

Class ProcessingApi

java.lang.Object

org.yamcs.protobuf.AbstractProcessingApi<Context>

org.yamcs.http.api.ProcessingApi

All Implemented Interfaces:

Api<Context>

public class ProcessingApi
extends AbstractProcessingApi<Context>

Constructor Summary

Constructors

Constructor	Description
ProcessingApi()

Method Summary

Modifier and Type	Method	Description
void	batchGetParameterValues(Context ctx, BatchGetParameterValuesRequest request, Observer<BatchGetParameterValuesResponse> observer)	Batch get the value of multiple parameters
void	batchSetParameterValues(Context ctx, BatchSetParameterValuesRequest request, Observer<com.google.protobuf.Empty> observer)	Batch set the value of multiple parameters
void	createProcessor(Context ctx, CreateProcessorRequest request, Observer<com.google.protobuf.Empty> observer)	Create a processor
void	deleteProcessor(Context ctx, DeleteProcessorRequest request, Observer<com.google.protobuf.Empty> observer)	Delete a processor Only replay processors can be removed.
void	editAlgorithmTrace(Context ctx, EditAlgorithmTraceRequest request, Observer<com.google.protobuf.Empty> observer)	Enable/disable algorithm tracing
void	editProcessor(Context ctx, EditProcessorRequest request, Observer<com.google.protobuf.Empty> observer)	Update a processor
void	getAlgorithmStatus(Context ctx, GetAlgorithmStatusRequest request, Observer<AlgorithmStatus> observer)	Get the algorithm status
void	getAlgorithmTrace(Context ctx, GetAlgorithmTraceRequest request, Observer<AlgorithmTrace> observer)	Get the algorithm trace
void	getParameterValue(Context ctx, GetParameterValueRequest request, Observer<Pvalue.ParameterValue> observer)	Get a parameter's value
void	getProcessor(Context ctx, GetProcessorRequest request, Observer<ProcessorInfo> observer)	Get a processor
void	listProcessors(Context ctx, ListProcessorsRequest request, Observer<ListProcessorsResponse> observer)	List processors
void	listProcessorTypes(Context ctx, com.google.protobuf.Empty request, Observer<ListProcessorTypesResponse> observer)	List processor types
void	setParameterValue(Context ctx, SetParameterValueRequest request, Observer<com.google.protobuf.Empty> observer)	Set a parameter's value Only some type of parameters can be updated.
void	subscribeAlgorithmStatus(Context ctx, SubscribeAlgorithmStatusRequest request, Observer<AlgorithmStatus> observer)	Receive algorithm status updates
Observer<SubscribeParametersRequest>	subscribeParameters(Context ctx, Observer<SubscribeParametersData> observer)	Receive parameter updates The input message can be sent multiple types, allowing to alter a subscription with the ``action`` field.
void	subscribeProcessors(Context ctx, SubscribeProcessorsRequest request, Observer<ProcessorInfo> observer)	Receive processor updates
void	subscribeTMStatistics(Context ctx, SubscribeTMStatisticsRequest request, Observer<Statistics> observer)	Receive TM statistics updates
static ProcessorInfo	toProcessorInfo(Processor processor)
static Processor	verifyProcessor(String instance, String processorName)

Methods inherited from class org.yamcs.protobuf.AbstractProcessingApi

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

ProcessingApi

public ProcessingApi()

Method Details

listProcessorTypes

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

Description copied from class: AbstractProcessingApi

  List processor types
 

Specified by:

listProcessorTypes in class AbstractProcessingApi<Context>

listProcessors

public void listProcessors(Context ctx,
 ListProcessorsRequest request,
 Observer<ListProcessorsResponse> observer)

Description copied from class: AbstractProcessingApi

  List processors
 

Specified by:

listProcessors in class AbstractProcessingApi<Context>

getProcessor

public void getProcessor(Context ctx,
 GetProcessorRequest request,
 Observer<ProcessorInfo> observer)

Description copied from class: AbstractProcessingApi

  Get a processor
 

Specified by:

getProcessor in class AbstractProcessingApi<Context>

deleteProcessor

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

Description copied from class: AbstractProcessingApi

  Delete a processor
 
  Only replay processors can be removed.
 

Specified by:

deleteProcessor in class AbstractProcessingApi<Context>

createProcessor

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

Description copied from class: AbstractProcessingApi

  Create a processor
 

Specified by:

createProcessor in class AbstractProcessingApi<Context>

editProcessor

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

Description copied from class: AbstractProcessingApi

  Update a processor
 

Specified by:

editProcessor in class AbstractProcessingApi<Context>

getParameterValue

public void getParameterValue(Context ctx,
 GetParameterValueRequest request,
 Observer<Pvalue.ParameterValue> observer)

Description copied from class: AbstractProcessingApi

  Get a parameter's value
 

Specified by:

getParameterValue in class AbstractProcessingApi<Context>

setParameterValue

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

Description copied from class: AbstractProcessingApi

  Set a parameter's value
 
  Only some type of parameters can be updated.
 

Specified by:

setParameterValue in class AbstractProcessingApi<Context>

subscribeParameters

public Observer<SubscribeParametersRequest> subscribeParameters(Context ctx,
 Observer<SubscribeParametersData> observer)

Description copied from class: AbstractProcessingApi

  Receive parameter updates
 
  The input message can be sent multiple types, allowing to alter a
  subscription with the ``action`` field.
 

Specified by:

subscribeParameters in class AbstractProcessingApi<Context>

subscribeProcessors

public void subscribeProcessors(Context ctx,
 SubscribeProcessorsRequest request,
 Observer<ProcessorInfo> observer)

Description copied from class: AbstractProcessingApi

  Receive processor updates
 

Specified by:

subscribeProcessors in class AbstractProcessingApi<Context>

batchGetParameterValues

public void batchGetParameterValues(Context ctx,
 BatchGetParameterValuesRequest request,
 Observer<BatchGetParameterValuesResponse> observer)

Description copied from class: AbstractProcessingApi

  Batch get the value of multiple parameters
 

Specified by:

batchGetParameterValues in class AbstractProcessingApi<Context>

batchSetParameterValues

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

Description copied from class: AbstractProcessingApi

  Batch set the value of multiple parameters
 

Specified by:

batchSetParameterValues in class AbstractProcessingApi<Context>

subscribeTMStatistics

public void subscribeTMStatistics(Context ctx,
 SubscribeTMStatisticsRequest request,
 Observer<Statistics> observer)

Description copied from class: AbstractProcessingApi

  Receive TM statistics updates
 

Specified by:

subscribeTMStatistics in class AbstractProcessingApi<Context>

getAlgorithmStatus

public void getAlgorithmStatus(Context ctx,
 GetAlgorithmStatusRequest request,
 Observer<AlgorithmStatus> observer)

Description copied from class: AbstractProcessingApi

  Get the algorithm status
 

Specified by:

getAlgorithmStatus in class AbstractProcessingApi<Context>

subscribeAlgorithmStatus

public void subscribeAlgorithmStatus(Context ctx,
 SubscribeAlgorithmStatusRequest request,
 Observer<AlgorithmStatus> observer)

Description copied from class: AbstractProcessingApi

  Receive algorithm status updates
 

Specified by:

subscribeAlgorithmStatus in class AbstractProcessingApi<Context>

editAlgorithmTrace

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

Description copied from class: AbstractProcessingApi

  Enable/disable algorithm tracing
 

Specified by:

editAlgorithmTrace in class AbstractProcessingApi<Context>

getAlgorithmTrace

public void getAlgorithmTrace(Context ctx,
 GetAlgorithmTraceRequest request,
 Observer<AlgorithmTrace> observer)

Description copied from class: AbstractProcessingApi

  Get the algorithm trace
 

Specified by:

getAlgorithmTrace in class AbstractProcessingApi<Context>

toProcessorInfo

public static ProcessorInfo toProcessorInfo(Processor processor)

verifyProcessor

public static Processor verifyProcessor(String instance,
 String processorName)