org.yamcs.parameter

Class SystemParametersProvider

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.parameter.SystemParametersProvider

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ParameterProvider, ProcessorService, StreamSubscriber

public class SystemParametersProvider
extends com.google.common.util.concurrent.AbstractService
implements StreamSubscriber, ParameterProvider

Provides system variables from the sys_var stream to ParameterRequestManager It also provides some info about the current yprocessor For the moment all variables starting with "/yamcs" are accepted and nothing else. Aliases are not supported.

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

Constructor Summary

Constructors

Constructor and Description
SystemParametersProvider(String yamcsInstance)

Method Summary

Modifier and Type	Method and Description
boolean	canProvide(Parameter para)
boolean	canProvide(Yamcs.NamedObjectId paraId) return true if parameter starts with "/YAMCS" or the namespace is null and the name starts with "/YAMCS"
protected void	doStart()
protected void	doStop()
Parameter	getParameter(Yamcs.NamedObjectId paraId) Returns the parameterDefinition corresponding to the parameter id
SystemParameter	getSystemParameter(String fqname) Get (and possibly create) system parameter.
void	init(Processor proc) Called before the startup to pass on the processor and initialize whatever needed
void	onTuple(Stream s, Tuple tuple)
void	setParameterListener(ParameterListener parameterRequestManager) 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
void	streamClosed(Stream s)

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, 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

init

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

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

Constructor Detail

SystemParametersProvider

public SystemParametersProvider(String yamcsInstance)
                         throws ConfigurationException

Throws:

ConfigurationException

Method Detail

init

public void init(Processor proc)
          throws ConfigurationException

Description copied from interface: ParameterProvider

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

Specified by:

init in interface ParameterProvider

Specified by:

init in interface ProcessorService

Throws:

ConfigurationException

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

onTuple

public void onTuple(Stream s,
                    Tuple tuple)

Specified by:

onTuple in interface StreamSubscriber

streamClosed

public void streamClosed(Stream s)

Specified by:

streamClosed in interface StreamSubscriber

canProvide

public boolean canProvide(Yamcs.NamedObjectId paraId)

return true if parameter starts with "/YAMCS" or the namespace is null and the name starts with "/YAMCS"

Specified by:

canProvide in interface ParameterProvider

Returns:

canProvide

public boolean canProvide(Parameter para)

Specified by:

canProvide in interface ParameterProvider

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

getSystemParameter

public SystemParameter getSystemParameter(String fqname)

Get (and possibly create) system parameter. The parameter may be in the XtceDB in case it is referred to by an algorithm. Otherwise is created on the fly and not added to XtceDB.

Parameters:

fqname - - the fully qualified name of the parameter to be returned

Returns:

the system parameter having the fqname.

setParameterListener

public void setParameterListener(ParameterListener parameterRequestManager)

Description copied from interface: ParameterProvider

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

Specified by:

setParameterListener 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