org.yamcs.client.processor

Class ProcessorClient

java.lang.Object

org.yamcs.client.processor.ProcessorClient

public class ProcessorClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessorClient.CommandBuilder
static class	ProcessorClient.GetOptions

Constructor Summary

Constructors

Constructor and Description
ProcessorClient(MethodHandler methodHandler, String instance, String processor)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Commanding.CommandQueueInfo>	blockQueue(String queue)
CompletableFuture<Void>	changeSpeed(String speed)
CompletableFuture<Commanding.CommandQueueInfo>	disableQueue(String queue)
CompletableFuture<Commanding.CommandQueueInfo>	enableQueue(String queue)
CompletableFuture<ProcessorInfo>	getInfo()
String	getInstance()
String	getProcessor()
CompletableFuture<Pvalue.ParameterValue>	getValue(String parameter, ProcessorClient.GetOptions.GetOption... options)
CompletableFuture<List<Pvalue.ParameterValue>>	getValues(List<String> parameters, ProcessorClient.GetOptions.GetOption... options)
CompletableFuture<Command>	issueCommand(String command, Map<String,?> arguments)
CompletableFuture<Void>	pause()
ProcessorClient.CommandBuilder	prepareCommand(String command)
CompletableFuture<Void>	rejectQueueEntry(String queue, String uuid)
CompletableFuture<Void>	releaseQueueEntry(String queue, String uuid)
CompletableFuture<Mdb.ParameterTypeInfo>	removeAlarms(String parameter)
CompletableFuture<Mdb.ParameterTypeInfo>	removeCalibrators(String parameter)
CompletableFuture<Void>	resume()
CompletableFuture<Mdb.ParameterTypeInfo>	revertAlarms(String parameter)
CompletableFuture<Void>	revertAlgorithm(String algorithm)
CompletableFuture<Mdb.ParameterTypeInfo>	revertCalibrators(String parameter)
CompletableFuture<Void>	seek(Instant instant)
CompletableFuture<Mdb.ParameterTypeInfo>	setAlarms(String parameter, Mdb.AlarmInfo defaultAlarm, List<Mdb.ContextAlarmInfo> contextAlarms)
CompletableFuture<Mdb.ParameterTypeInfo>	setCalibrators(String parameter, Mdb.CalibratorInfo defaultCalibrator, List<Mdb.ContextCalibratorInfo> contextCalibrators)
CompletableFuture<Mdb.ParameterTypeInfo>	setDefaultAlarm(String parameter, Mdb.AlarmInfo alarm)
CompletableFuture<Mdb.ParameterTypeInfo>	setDefaultCalibrator(String parameter, Mdb.CalibratorInfo calibrator)
CompletableFuture<Void>	setValue(String parameter, Yamcs.Value value)
CompletableFuture<Void>	setValues(Map<String,Yamcs.Value> values)
CompletableFuture<Void>	updateAlgorithm(String algorithm, Mdb.AlgorithmInfo definition)
CompletableFuture<Void>	updateCommand(String command, String commandId, Map<String,Yamcs.Value> attributes)
CompletableFuture<Void>	updateCommand(String command, String commandId, String attribute, Yamcs.Value value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessorClient

public ProcessorClient(MethodHandler methodHandler,
                       String instance,
                       String processor)

Method Detail

getInstance

public String getInstance()

getProcessor

public String getProcessor()

getInfo

public CompletableFuture<ProcessorInfo> getInfo()

getValue

public CompletableFuture<Pvalue.ParameterValue> getValue(String parameter,
                                                         ProcessorClient.GetOptions.GetOption... options)

getValues

public CompletableFuture<List<Pvalue.ParameterValue>> getValues(List<String> parameters,
                                                                ProcessorClient.GetOptions.GetOption... options)

setValue

public CompletableFuture<Void> setValue(String parameter,
                                        Yamcs.Value value)

setValues

public CompletableFuture<Void> setValues(Map<String,Yamcs.Value> values)

issueCommand

public CompletableFuture<Command> issueCommand(String command,
                                               Map<String,?> arguments)

prepareCommand

public ProcessorClient.CommandBuilder prepareCommand(String command)

pause

public CompletableFuture<Void> pause()

resume

public CompletableFuture<Void> resume()

seek

public CompletableFuture<Void> seek(Instant instant)

changeSpeed

public CompletableFuture<Void> changeSpeed(String speed)

updateCommand

public CompletableFuture<Void> updateCommand(String command,
                                             String commandId,
                                             String attribute,
                                             Yamcs.Value value)

updateCommand

public CompletableFuture<Void> updateCommand(String command,
                                             String commandId,
                                             Map<String,Yamcs.Value> attributes)

setDefaultCalibrator

public CompletableFuture<Mdb.ParameterTypeInfo> setDefaultCalibrator(String parameter,
                                                                     Mdb.CalibratorInfo calibrator)

setCalibrators

public CompletableFuture<Mdb.ParameterTypeInfo> setCalibrators(String parameter,
                                                               Mdb.CalibratorInfo defaultCalibrator,
                                                               List<Mdb.ContextCalibratorInfo> contextCalibrators)

removeCalibrators

public CompletableFuture<Mdb.ParameterTypeInfo> removeCalibrators(String parameter)

revertCalibrators

public CompletableFuture<Mdb.ParameterTypeInfo> revertCalibrators(String parameter)

setDefaultAlarm

public CompletableFuture<Mdb.ParameterTypeInfo> setDefaultAlarm(String parameter,
                                                                Mdb.AlarmInfo alarm)

setAlarms

public CompletableFuture<Mdb.ParameterTypeInfo> setAlarms(String parameter,
                                                          Mdb.AlarmInfo defaultAlarm,
                                                          List<Mdb.ContextAlarmInfo> contextAlarms)

removeAlarms

public CompletableFuture<Mdb.ParameterTypeInfo> removeAlarms(String parameter)

revertAlarms

public CompletableFuture<Mdb.ParameterTypeInfo> revertAlarms(String parameter)

updateAlgorithm

public CompletableFuture<Void> updateAlgorithm(String algorithm,
                                               Mdb.AlgorithmInfo definition)

revertAlgorithm

public CompletableFuture<Void> revertAlgorithm(String algorithm)

enableQueue

public CompletableFuture<Commanding.CommandQueueInfo> enableQueue(String queue)

disableQueue

public CompletableFuture<Commanding.CommandQueueInfo> disableQueue(String queue)

blockQueue

public CompletableFuture<Commanding.CommandQueueInfo> blockQueue(String queue)

rejectQueueEntry

public CompletableFuture<Void> rejectQueueEntry(String queue,
                                                String uuid)

releaseQueueEntry

public CompletableFuture<Void> releaseQueueEntry(String queue,
                                                 String uuid)