org.yamcs.parameter

Interface ParameterProvider

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

AlgorithmManager, ReplayService, SoftwareParameterManager, StreamParameterProvider, SystemParametersProvider, XtceTmProcessor

public interface ParameterProvider
extends com.google.common.util.concurrent.Service

interface implemented by all the classes that can provide parameters to the ParameterRequestManager. When the classes inherited from this object are created as part of a realtime processor, they need two constructors: (String yamcsInstance, args) When called as part of a replay processor, the following constructor is invoked (String yamcsInstance, args, ReplayRequest) args is the yaml parsed object used in the definition of the provider in yprocessor.yaml

Author:

nm

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

Method Summary

Modifier and Type	Method and Description
boolean	canProvide(Parameter param)
boolean	canProvide(Yamcs.NamedObjectId paraId) Returns whether or not a given parameter can be provided by this provider
Parameter	getParameter(Yamcs.NamedObjectId paraId) Returns the parameterDefinition corresponding to the parameter id
void	init(YProcessor processor) Called before the startup to pass on the processor and initialize whatever needed
void	setParameterListener(ParameterRequestManager parameterListener) Send parameters to this listener.
void	startProviding(Parameter paramDef) Adds a new parameter to the list of parameters that have to provided
void	startProvidingAll() start providing all known parameters
void	stopProviding(Parameter paramDef) Removes a parameter from the list of parameters that have to be provided

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Method Detail

init

void init(YProcessor processor)
   throws ConfigurationException

Called before the startup to pass on the processor and initialize whatever needed

Parameters:

processor -

Throws:

ConfigurationException

setParameterListener

void setParameterListener(ParameterRequestManager parameterListener)

Send parameters to this listener. Normally is the channel.parameterRequestManager but something different may be used for unit tests or special applications (PacketViewer)

Parameters:

parameterListener -

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(Yamcs.NamedObjectId paraId)

Returns whether or not a given parameter can be provided by this provider

Returns:

getParameter

Parameter getParameter(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)