Package org.yamcs.parameter

Class SystemParametersCollector

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.AbstractYamcsService

org.yamcs.parameter.SystemParametersCollector

All Implemented Interfaces:

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

public class SystemParametersCollector
extends AbstractYamcsService
implements Runnable

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

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	Description
static int	FS_COLLECTION_INTERVAL
static int	JVM_COLLECTION_INTERVAL

Fields inherited from class org.yamcs.AbstractYamcsService

config, log, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
SystemParametersCollector()

Method Summary

Modifier and Type	Method	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, float v)
static ParameterValue	getPV(String fqn, long time, long v)
static ParameterValue	getPV(String fqn, long time, String v)
static ParameterValue	getPV(String fqn, long time, Value v)
Spec	getSpec()	Returns the valid configuration options for this service.
static ParameterValue	getUnsignedIntPV(String fqn, long time, int v)
void	init(String yamcsInstance, YConfiguration config)	Initialize this service.
void	registerProducer(SystemParametersProducer p)	Register a parameter producer to be called each time the parameters are collected
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 org.yamcs.AbstractYamcsService

getConfig, getYamcsInstance

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 com.google.common.util.concurrent.Service

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

Field Detail

JVM_COLLECTION_INTERVAL

public static final int JVM_COLLECTION_INTERVAL

See Also:

Constant Field Values

FS_COLLECTION_INTERVAL

public static final int FS_COLLECTION_INTERVAL

See Also:

Constant Field Values

Constructor Detail

SystemParametersCollector

public SystemParametersCollector()

Method Detail

getSpec

public Spec getSpec()

Description copied from interface: YamcsService

Returns the valid configuration options for this service.

Specified by:

getSpec in interface YamcsService

Returns:

the argument specification, or null if the args should not be validated.

init

public void init(String yamcsInstance,
                 YConfiguration config)
          throws InitException

Description copied from interface: YamcsService

Initialize this service. This is called before the service is started. All operations should finish fast.

Specified by:

init in interface YamcsService

Overrides:

init in class AbstractYamcsService

Parameters:

yamcsInstance - The yamcs instance, or null if this is a global service.

config - The configured arguments for this service. If YamcsService.getSpec() is implemented then this contains the arguments after being validated (including any defaults).

Throws:

InitException - When something goes wrong during the execution of this method.

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

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,
                                   float 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)

getPV

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