Package org.yamcs.parameter
Class LocalParameterManager
java.lang.Object
com.google.common.util.concurrent.AbstractService
org.yamcs.AbstractProcessorService
org.yamcs.parameter.LocalParameterManager
- All Implemented Interfaces:
com.google.common.util.concurrent.Service
,ParameterProvider
,SoftwareParameterManager
,ProcessorService
public class LocalParameterManager
extends AbstractProcessorService
implements SoftwareParameterManager, ParameterProvider
Implements local parameters - these are parameters that can be set from the clients.
All the parameters are sent from the executor thread.
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service
com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State
-
Field Summary
Fields inherited from class org.yamcs.AbstractProcessorService
config, log, processor
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addParameterListener
(ParameterProcessor parameterListener) boolean
canProvide
(Yamcs.NamedObjectId paraId) Returns whether or not a given parameter can be provided by this providerboolean
canProvide
(Parameter param) protected void
doStart()
protected void
doStop()
getParameter
(Yamcs.NamedObjectId paraId) Returns the parameterDefinition corresponding to the parameter idvoid
init
(Processor proc, YConfiguration config, Object spec) void
setParameterProcessor
(ParameterProcessor parameterListener) Send parameters to this processor.void
startProviding
(Parameter paramDef) Adds a new parameter to the list of parameters that have to providedvoid
start providing all known parametersvoid
stopProviding
(Parameter paramDef) Removes a parameter from the list of parameters that have to be providedvoid
sync()
void
updateParameter
(Parameter p, Value engValue) Updates a parameter just with the engineering valuevoid
updateParameters
(List<ParameterValue> pvList) update the list of parameters.Methods inherited from class org.yamcs.AbstractProcessorService
getConfig, getYamcsInstance
Methods inherited from class com.google.common.util.concurrent.AbstractService
addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.yamcs.ProcessorService
getSpec
Methods inherited from interface com.google.common.util.concurrent.Service
addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync
-
Constructor Details
-
LocalParameterManager
public LocalParameterManager()
-
-
Method Details
-
init
- Specified by:
init
in interfaceProcessorService
- Overrides:
init
in classAbstractProcessorService
config
- service configuration as specified in processor.yamlspec
- passed by the user when creating the processor (for instance via the REST API)
-
setParameterProcessor
Description copied from interface:ParameterProvider
Send parameters to this processor.- Specified by:
setParameterProcessor
in interfaceParameterProvider
-
addParameterListener
-
updateParameters
update the list of parameters.Converts the value to the target type and sends the result to PRM
- Specified by:
updateParameters
in interfaceSoftwareParameterManager
-
updateParameter
Updates a parameter just with the engineering value- Specified by:
updateParameter
in interfaceSoftwareParameterManager
-
startProviding
Description copied from interface:ParameterProvider
Adds a new parameter to the list of parameters that have to provided- Specified by:
startProviding
in interfaceParameterProvider
-
startProvidingAll
public void startProvidingAll()Description copied from interface:ParameterProvider
start providing all known parameters- Specified by:
startProvidingAll
in interfaceParameterProvider
-
stopProviding
Description copied from interface:ParameterProvider
Removes a parameter from the list of parameters that have to be provided- Specified by:
stopProviding
in interfaceParameterProvider
-
canProvide
Description copied from interface:ParameterProvider
Returns whether or not a given parameter can be provided by this provider- Specified by:
canProvide
in interfaceParameterProvider
- Returns:
-
getParameter
Description copied from interface:ParameterProvider
Returns the parameterDefinition corresponding to the parameter id- Specified by:
getParameter
in interfaceParameterProvider
- Parameters:
paraId
- - id of the parameter that is returned- Returns:
- Throws:
InvalidIdentification
-
canProvide
- Specified by:
canProvide
in interfaceParameterProvider
-
doStart
protected void doStart()- Specified by:
doStart
in classcom.google.common.util.concurrent.AbstractService
-
doStop
protected void doStop()- Specified by:
doStop
in classcom.google.common.util.concurrent.AbstractService
-
sync
-