Package org.yamcs.parameter
Interface ParameterProvider
-
- All Superinterfaces:
ProcessorService
,com.google.common.util.concurrent.Service
- All Known Implementing Classes:
AlgorithmManager
,LocalParameterManager
,ReplayService
,StreamParameterProvider
,XtceTmProcessor
public interface ParameterProvider extends ProcessorService
interface implemented by all the classes that can provide parameters to theParameterProcessorManager
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canProvide(org.yamcs.protobuf.Yamcs.NamedObjectId paraId)
Returns whether or not a given parameter can be provided by this providerboolean
canProvide(Parameter param)
Parameter
getParameter(org.yamcs.protobuf.Yamcs.NamedObjectId paraId)
Returns the parameterDefinition corresponding to the parameter idvoid
setParameterProcessor(ParameterProcessor parameterProcessor)
Send parameters to this processor.void
startProviding(Parameter paramDef)
Adds a new parameter to the list of parameters that have to providedvoid
startProvidingAll()
start providing all known parametersvoid
stopProviding(Parameter paramDef)
Removes a parameter from the list of parameters that have to be provided-
Methods inherited from interface org.yamcs.ProcessorService
getSpec, init
-
-
-
-
Method Detail
-
setParameterProcessor
void setParameterProcessor(ParameterProcessor parameterProcessor)
Send parameters to this processor.- Parameters:
parameterProcessor
-
-
startProviding
void startProviding(Parameter paramDef)
Adds a new parameter to the list of parameters that have to provided- Parameters:
paramDef
-
-
startProvidingAll
void startProvidingAll()
start providing all known parameters
-
stopProviding
void stopProviding(Parameter paramDef)
Removes a parameter from the list of parameters that have to be provided- Parameters:
paramDef
-
-
canProvide
boolean canProvide(org.yamcs.protobuf.Yamcs.NamedObjectId paraId)
Returns whether or not a given parameter can be provided by this provider- Returns:
-
getParameter
Parameter getParameter(org.yamcs.protobuf.Yamcs.NamedObjectId paraId) throws InvalidIdentification
Returns the parameterDefinition corresponding to the parameter id- Parameters:
paraId
- - id of the parameter that is returned- Returns:
- Throws:
InvalidIdentification
-
canProvide
boolean canProvide(Parameter param)
-
-