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

Constructors

Constructor	Description
LocalParameterManager()

Method Summary

Modifier and Type	Method	Description
void	addParameterListener(ParameterProcessor parameterListener)
boolean	canProvide(Yamcs.NamedObjectId paraId)	Returns whether or not a given parameter can be provided by this provider
boolean	canProvide(Parameter param)
protected void	doStart()
protected void	doStop()
Parameter	getParameter(Yamcs.NamedObjectId paraId)	Returns the parameterDefinition corresponding to the parameter id
void	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 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
void	sync()
void	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

Methods inherited from interface org.yamcs.parameter.SoftwareParameterManager

updateParameter

Constructor Details

LocalParameterManager

public LocalParameterManager()

Method Details

init

public void init(Processor proc,
 YConfiguration config,
 Object spec)

Specified by:

init in interface ProcessorService

Overrides:

init in class AbstractProcessorService

config - service configuration as specified in processor.yaml

spec - passed by the user when creating the processor (for instance via the REST API)

setParameterProcessor

public void setParameterProcessor(ParameterProcessor parameterListener)

Description copied from interface: ParameterProvider

Send parameters to this processor.

Specified by:

setParameterProcessor in interface ParameterProvider

addParameterListener

public void addParameterListener(ParameterProcessor parameterListener)

updateParameters

public void updateParameters(List<ParameterValue> pvList)

update the list of parameters.

Converts the value to the target type and sends the result to PRM

Specified by:

updateParameters in interface SoftwareParameterManager

startProviding

public void startProviding(Parameter paramDef)

Description copied from interface: ParameterProvider

Adds a new parameter to the list of parameters that have to provided

Specified by:

startProviding in interface ParameterProvider

startProvidingAll

public void startProvidingAll()

Description copied from interface: ParameterProvider

start providing all known parameters

Specified by:

startProvidingAll in interface ParameterProvider

stopProviding

public void stopProviding(Parameter paramDef)

Description copied from interface: ParameterProvider

Removes a parameter from the list of parameters that have to be provided

Specified by:

stopProviding in interface ParameterProvider

canProvide

public boolean canProvide(Yamcs.NamedObjectId paraId)

Description copied from interface: ParameterProvider

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

Specified by:

canProvide in interface ParameterProvider

Returns:

getParameter

public Parameter getParameter(Yamcs.NamedObjectId paraId)
                       throws InvalidIdentification

Description copied from interface: ParameterProvider

Returns the parameterDefinition corresponding to the parameter id

Specified by:

getParameter in interface ParameterProvider

Parameters:

paraId - - id of the parameter that is returned

Returns:

Throws:

InvalidIdentification

canProvide

public boolean canProvide(Parameter param)

Specified by:

canProvide in interface ParameterProvider

doStart

protected void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

protected void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

sync

public void sync()
          throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException