org.yamcs.parameter

Class ParameterRequestManager

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.parameter.ParameterRequestManager

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ParameterListener

public class ParameterRequestManager
extends com.google.common.util.concurrent.AbstractService
implements ParameterListener

Keeps track of which parameters are part of which subscriptions. There are two types of subscriptions: - subscribe all - subscribe to a set Both types have an unique id associated but different methods work with them

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

Modifier and Type	Field and Description
Processor	yproc

Constructor Summary

Constructors

Constructor and Description
ParameterRequestManager(Processor yproc, XtceTmProcessor tmProcessor) Creates a new ParameterRequestManager, configured to listen to the specified XtceTmProcessor.

Method Summary

Modifier and Type	Method and Description
void	addItemsToRequest(int subscriptionId, List<Parameter> paraList) Add items to a subscription.
void	addItemsToRequest(int subscriptionId, Parameter para) Add items to an request id.
void	addParameterProvider(ParameterProvider parameterProvider)
void	addRequest(int subscriptionId, List<Parameter> paraList, ParameterConsumer tpc) Create request with a given id.
int	addRequest(List<Parameter> paraList, DVParameterConsumer dvtpc) Creates a new request with a list of parameters
int	addRequest(List<Parameter> paraList, ParameterConsumer tpc)
int	addRequest(Parameter para, ParameterConsumer tpc) Creates a request with one parameter
protected void	doStart()
protected void	doStop()
AlarmChecker	getAlarmChecker()
AlarmServer	getAlarmServer()
ParameterValue	getLastValueFromCache(Parameter param) Get the last value from cache for a specific parameters
Parameter	getParameter(String fqn) returns a parameter based on fully qualified name
Parameter	getParameter(Yamcs.NamedObjectId paraId)
ParameterCache	getParameterCache()
<T extends ParameterProvider> T	getParameterProvider(Class<T> type)
SoftwareParameterManager	getSoftwareParameterManager()
List<ParameterValue>	getValuesFromCache(List<Parameter> plist)
List<ParameterValue>	getValuesFromCache(Parameter param) Get all the values from cache for a specific parameters The parameter are returned in descending order (newest parameter is returned first)
Object	getXtceDb()
boolean	hasParameterCache()
void	init() This is called after all the parameter providers have been added but before the start.
void	removeItemsFromRequest(int subscriptionID, List<Parameter> paraList) Removes a list of parameters from a request.
void	removeItemsFromRequest(int subscriptionID, Parameter param) Removes a parameter from a rquest.
List<Parameter>	removeRequest(int subscriptionId) Removes all the items from this subscription and returns them into an List.
int	subscribeAll(ParameterConsumer consumer) subscribes to all parameters
String	toString()
boolean	unsubscribeAll(int subscriptionId) removes the subscription to all parameters return true of the subscription has been removed or false if it was not there
void	update(Collection<ParameterValue> params) Called each time some parameters have been updated.

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

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

yproc

public final Processor yproc

Constructor Detail

ParameterRequestManager

public ParameterRequestManager(Processor yproc,
                               XtceTmProcessor tmProcessor)
                        throws ConfigurationException

Creates a new ParameterRequestManager, configured to listen to the specified XtceTmProcessor.

Throws:

ConfigurationException

Method Detail

addParameterProvider

public void addParameterProvider(ParameterProvider parameterProvider)

init

public void init()

This is called after all the parameter providers have been added but before the start. We subscribe to all parameters if cacheAll is enabled this way we give the opportunity to the ReplayService to find out what is required to retrieve from the ReplayServer

subscribeAll

public int subscribeAll(ParameterConsumer consumer)

subscribes to all parameters

unsubscribeAll

public boolean unsubscribeAll(int subscriptionId)

removes the subscription to all parameters return true of the subscription has been removed or false if it was not there

Parameters:

subscriptionId -

Returns:

addRequest

public int addRequest(List<Parameter> paraList,
                      ParameterConsumer tpc)

addRequest

public int addRequest(Parameter para,
                      ParameterConsumer tpc)

Creates a request with one parameter

Parameters:

para -

tpc -

Returns:

addRequest

public int addRequest(List<Parameter> paraList,
                      DVParameterConsumer dvtpc)

Creates a new request with a list of parameters

Parameters:

paraList -

dvtpc -

Returns:

subscription id

addRequest

public void addRequest(int subscriptionId,
                       List<Parameter> paraList,
                       ParameterConsumer tpc)

Create request with a given id. This is called when switching yprocessors, the id is coming from the other channel.

Parameters:

subscriptionId - - subscription id

paraList -

tpc -

addItemsToRequest

public void addItemsToRequest(int subscriptionId,
                              Parameter para)
                       throws InvalidRequestIdentification

Add items to an request id.

Parameters:

subscriptionId -

para -

Throws:

InvalidRequestIdentification

addItemsToRequest

public void addItemsToRequest(int subscriptionId,
                              List<Parameter> paraList)
                       throws InvalidRequestIdentification

Add items to a subscription.

Parameters:

subscriptionId -

paraList - - list of parameters that are added to the subscription

Throws:

InvalidIdentification

InvalidRequestIdentification

removeItemsFromRequest

public void removeItemsFromRequest(int subscriptionID,
                                   Parameter param)

Removes a parameter from a rquest. If it is not part of the request, the operation will have no effect.

Parameters:

subscriptionID -

param -

Throws:

InvalidIdentification

removeItemsFromRequest

public void removeItemsFromRequest(int subscriptionID,
                                   List<Parameter> paraList)

Removes a list of parameters from a request. Any parameter specified that is not in the subscription will be ignored.

Parameters:

subscriptionID -

paraList -

removeRequest

public List<Parameter> removeRequest(int subscriptionId)

Removes all the items from this subscription and returns them into an List. The result is usually used in the TelemetryImpl to move this subscription to a different ParameterRequestManager

getParameter

public Parameter getParameter(String fqn)
                       throws InvalidIdentification

returns a parameter based on fully qualified name

Parameters:

fqn -

Returns:

Throws:

InvalidIdentification

getParameter

public Parameter getParameter(Yamcs.NamedObjectId paraId)
                       throws InvalidIdentification

Parameters:

paraId -

Returns:

the corresponding parameter definition for a IntemIdentification

Throws:

InvalidIdentification - in case no provider knows of this parameter.

update

public void update(Collection<ParameterValue> params)

Description copied from interface: ParameterListener

Called each time some parameters have been updated.

Specified by:

update in interface ParameterListener

Parameters:

params - - new delivered parameter values

getSoftwareParameterManager

public SoftwareParameterManager getSoftwareParameterManager()

Returns:

the SoftwareParameterManager or null if not configured

getParameterProvider

public <T extends ParameterProvider> T getParameterProvider(Class<T> type)

getAlarmChecker

public AlarmChecker getAlarmChecker()

toString

public String toString()

Overrides:

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

getAlarmServer

public AlarmServer getAlarmServer()

hasParameterCache

public boolean hasParameterCache()

getValuesFromCache

public List<ParameterValue> getValuesFromCache(List<Parameter> plist)

getLastValueFromCache

public ParameterValue getLastValueFromCache(Parameter param)

Get the last value from cache for a specific parameters

Parameters:

param -

Returns:

getValuesFromCache

public List<ParameterValue> getValuesFromCache(Parameter param)

Get all the values from cache for a specific parameters The parameter are returned in descending order (newest parameter is returned first)

Parameters:

param -

Returns:

getParameterCache

public ParameterCache getParameterCache()

getXtceDb

public Object getXtceDb()

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