org.yamcs.parameter

Class SystemParametersCollector

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.parameter.SystemParametersCollector

All Implemented Interfaces:

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

public class SystemParametersCollector
extends com.google.common.util.concurrent.AbstractService
implements Runnable

Collects each second system processed parameters from whomever registers and sends them on the sys_var stream

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	JVM_COLLECTION_INTERVAL

Constructor Summary

Constructors

Constructor and Description
SystemParametersCollector(String instance)
SystemParametersCollector(String instance, Map<String,Object> args)

Method Summary

Modifier and Type	Method and Description
void	doStart()
void	doStop()
static SystemParametersCollector	getInstance(String instance)
String	getNamespace() this is the namespace all system parameters should be in
static ParameterValue	getNewPv(String fqn, long time)
static ParameterValue	getPV(String fqn, long time, boolean v)
static ParameterValue	getPV(String fqn, long time, double v)
static ParameterValue	getPV(String fqn, long time, long v)
static ParameterValue	getPV(String fqn, long time, String v)
static ParameterValue	getUnsignedIntPV(String fqn, long time, int v)
void	registerProducer(SystemParametersProducer p) Register a parameter producer to be called each time the parameters are collected
void	registerProvider(SystemParametersProducer p) Deprecated. old name for registerProducer(org.yamcs.parameter.SystemParametersProducer)
void	registerProvider(SystemParametersProducer p, Collection<Parameter> params) Deprecated. use registerProvider(SystemParametersProducer p) instead. There is no need to specify which paramameters will be provided and in addition they don't even need to be part of the Xtcedb (i.e. the provider can make them up on the fly)
void	run() Run from the timer, collect all parameters and send them on the stream
void	unregisterProducer(SystemParametersProducer p) Unregister producer - from now on it will not be invoked.

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

Field Detail

JVM_COLLECTION_INTERVAL

public static final int JVM_COLLECTION_INTERVAL

See Also:

Constant Field Values

Constructor Detail

SystemParametersCollector

public SystemParametersCollector(String instance)
                          throws ConfigurationException

Throws:

ConfigurationException

SystemParametersCollector

public SystemParametersCollector(String instance,
                                 Map<String,Object> args)
                          throws ConfigurationException

Throws:

ConfigurationException

Method Detail

getInstance

public static SystemParametersCollector getInstance(String instance)

doStart

public void doStart()

Specified by:

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

doStop

public void doStop()

Specified by:

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

run

public void run()

Run from the timer, collect all parameters and send them on the stream

Specified by:

run in interface Runnable

registerProvider

@Deprecated
public void registerProvider(SystemParametersProducer p,
                                         Collection<Parameter> params)

Deprecated. use registerProvider(SystemParametersProducer p) instead. There is no need to specify which paramameters will be provided and in addition they don't even need to be part of the Xtcedb (i.e. the provider can make them up on the fly)

Register a parameter producer to be called each time the parameters are collected

registerProvider

@Deprecated
public void registerProvider(SystemParametersProducer p)

Deprecated. old name for registerProducer(org.yamcs.parameter.SystemParametersProducer)

registerProducer

public void registerProducer(SystemParametersProducer p)

Register a parameter producer to be called each time the parameters are collected

unregisterProducer

public void unregisterProducer(SystemParametersProducer p)

Unregister producer - from now on it will not be invoked. Note that the collector collects parameters into a different thread taking all producer in turns, and there might be one collection already started when this method is called.

getNamespace

public String getNamespace()

this is the namespace all system parameters should be in

Returns:

the namespace to be used by the system parameters

getNewPv

public static ParameterValue getNewPv(String fqn,
                                      long time)

getPV

public static ParameterValue getPV(String fqn,
                                   long time,
                                   String v)

getPV

public static ParameterValue getPV(String fqn,
                                   long time,
                                   double v)

getPV

public static ParameterValue getPV(String fqn,
                                   long time,
                                   boolean v)

getPV

public static ParameterValue getPV(String fqn,
                                   long time,
                                   long v)

getUnsignedIntPV

public static ParameterValue getUnsignedIntPV(String fqn,
                                              long time,
                                              int v)