java.lang.Object
com.google.common.util.concurrent.AbstractService
org.yamcs.AbstractProcessorService
org.yamcs.tctm.StreamParameterProvider
- All Implemented Interfaces:
com.google.common.util.concurrent.Service,ParameterProvider,ProcessorService,StreamSubscriber
public class StreamParameterProvider
extends AbstractProcessorService
implements StreamSubscriber, ParameterProvider
Provides parameters from yarch streams (pp_realtime) to
ParameterProcessorManager-
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleancanProvide(org.yamcs.protobuf.Yamcs.NamedObjectId id) Returns whether or not a given parameter can be provided by this providerbooleanprotected voiddoStart()protected voiddoStop()getParameter(org.yamcs.protobuf.Yamcs.NamedObjectId id) Returns the parameterDefinition corresponding to the parameter idvoidinit(Processor processor, YConfiguration config, Object spec) voidMake sure all parameters are defined in the XtceDB, otherwise the PRM will chokevoidsetParameterProcessor(ParameterProcessor paraListener) Send parameters to this processor.voidstartProviding(Parameter paramDef) Adds a new parameter to the list of parameters that have to providedvoidstart providing all known parametersvoidstopProviding(Parameter paramDef) Removes a parameter from the list of parameters that have to be providedvoidMethods inherited from class org.yamcs.AbstractProcessorService
getConfig, getYamcsInstanceMethods 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, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.yamcs.ProcessorService
getSpecMethods inherited from interface com.google.common.util.concurrent.Service
addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync
-
Constructor Details
-
StreamParameterProvider
public StreamParameterProvider()
-
-
Method Details
-
init
- Specified by:
initin interfaceProcessorService- Overrides:
initin classAbstractProcessorServiceconfig- service configuration as specified in processor.yamlspec- passed by the user when creating the processor (for instance via the REST API)
-
doStart
protected void doStart()- Specified by:
doStartin classcom.google.common.util.concurrent.AbstractService
-
doStop
protected void doStop()- Specified by:
doStopin classcom.google.common.util.concurrent.AbstractService
-
onTuple
Make sure all parameters are defined in the XtceDB, otherwise the PRM will choke- Specified by:
onTuplein interfaceStreamSubscriber
-
streamClosed
- Specified by:
streamClosedin interfaceStreamSubscriber
-
setParameterProcessor
Description copied from interface:ParameterProviderSend parameters to this processor.- Specified by:
setParameterProcessorin interfaceParameterProvider
-
stopProviding
Description copied from interface:ParameterProviderRemoves a parameter from the list of parameters that have to be provided- Specified by:
stopProvidingin interfaceParameterProvider
-
canProvide
public boolean canProvide(org.yamcs.protobuf.Yamcs.NamedObjectId id) Description copied from interface:ParameterProviderReturns whether or not a given parameter can be provided by this provider- Specified by:
canProvidein interfaceParameterProvider- Returns:
-
canProvide
- Specified by:
canProvidein interfaceParameterProvider
-
getParameter
public Parameter getParameter(org.yamcs.protobuf.Yamcs.NamedObjectId id) throws InvalidIdentification Description copied from interface:ParameterProviderReturns the parameterDefinition corresponding to the parameter id- Specified by:
getParameterin interfaceParameterProvider- Parameters:
id- - id of the parameter that is returned- Returns:
- Throws:
InvalidIdentification
-
startProviding
Description copied from interface:ParameterProviderAdds a new parameter to the list of parameters that have to provided- Specified by:
startProvidingin interfaceParameterProvider
-
startProvidingAll
public void startProvidingAll()Description copied from interface:ParameterProviderstart providing all known parameters- Specified by:
startProvidingAllin interfaceParameterProvider
-