Module org.yamcs.client

Package 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	Description
static class	ProcessorClient.CommandBuilder
static final class	ProcessorClient.GetOptions

Constructor Summary

Constructors

Constructor	Description
ProcessorClient(org.yamcs.api.MethodHandler methodHandler, String instance, String processor)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessorClient

public ProcessorClient(org.yamcs.api.MethodHandler methodHandler,
 String instance,
 String processor)

Method Details

getInstance

public String getInstance()

getProcessor

public String getProcessor()

getInfo

public CompletableFuture<org.yamcs.protobuf.ProcessorInfo> getInfo()

getValue

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

getValues

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

setValue

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

setValues

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

issueCommand

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

issueCommand

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

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,
 org.yamcs.protobuf.Yamcs.Value value)

updateCommand

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

setDefaultCalibrator

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

setCalibrators

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

removeCalibrators

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

revertCalibrators

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

setDefaultAlarm

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

setAlarms

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

removeAlarms

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

revertAlarms

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

updateAlgorithm

public CompletableFuture<Void> updateAlgorithm(String algorithm,
 String text)

revertAlgorithm

public CompletableFuture<Void> revertAlgorithm(String algorithm)

enableQueue

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

disableQueue

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

blockQueue

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

rejectCommand

public CompletableFuture<Void> rejectCommand(String queue,
 String commandId)

acceptCommand

public CompletableFuture<Void> acceptCommand(String queue,
 String commandId)