org.lsst.ccs.subsystem.daq

Class DaqStatsMonitor

java.lang.Object

org.lsst.ccs.subsystem.daq.DaqStatsMonitor

All Implemented Interfaces:

org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.services.HasDataProviderInfos

public class DaqStatsMonitor
extends Object
implements org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.config.ConfigurationBulkChangeHandler, org.lsst.ccs.services.HasDataProviderInfos

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	minDiffAlertWarning
protected Integer	minDiffLogWarning
protected List<String>	sumDriverChecks
protected List<String>	sumDriverStats
protected List<String>	sumFirmwareChecks
protected List<String>	sumFirmwareStats
protected List<String>	sumRdsChecks
protected List<String>	sumRdsStats
protected List<String>	sumRmsChecks
protected List<String>	sumRmsStats

Constructor Summary

Constructors

Constructor and Description
DaqStatsMonitor() Constructor

Method Summary

Modifier and Type	Method and Description
void	build() build phase: set up periodic task for publication
String	clearAllDriver(String location) Print and Clear all DAQ Driver statistics data for specified Location Like readAllDriver, but clears data after reading
String	clearAllFirmware(String location) Print and Clear all DAQ Firmware statistics data for specified Location Like readAllFirmware, but clears data after reading
String	clearAllRds(String location) Print and Clear all DAQ Rds statistics data for specified Location Like readAllRds, but clears data after reading
String	clearAllRms(String location) Print and Clear all DAQ Rms statistics data for specified Location Like readAllRms, but clears data after reading
String	clearAllStats(String location) Print then clear all four sets of statisics for specified location
String	clearStatsAllLocations() Clear all four sets of statisics for all locations
List<org.lsst.ccs.bus.data.DataProviderInfo>	getDataProviderInfos() This method of HasDataProviderInfo is used to register summed data, including units, for publication.
void	init() init phase: open connection to DAQ partition Also, use first Daq location to verify ConfigurationParameter Lists
boolean	isOnline() Gets the online state.
void	publishDataProviderCurrentData(org.lsst.ccs.bus.data.AgentInfo a) Not used, but present to complete HasDataProviderInfos interace
String	readAllDriver(String location) Print all DAQ Driver statistics data for specified Location Reads all DAQDriverStatistics values and return them in table format.
String	readAllFirmware(String location) Print all DAQ Firmware statistics data for specified Location Reads all DAQFirmwareStatistics values and return them in table format.
String	readAllRds(String location) Print all DAQ Rds statistics data for specified Location Reads all DAQRdsStatistics values and return them in table format.
String	readAllRms(String location) Print all DAQ Rms statistics data for specified Location Reads all DAQRmsStatistics values and return them in table format.
String	readAllStats(String location) Print all four sets of statisics for specified location
String	readDriverStat(String location, String quantity) Read specified entry in DAQ Driver Stats for specified location
String	readFirmwareStat(String location, String quantity) Read specified entry in DAQ Firmware Stats for specified location
String	readRdsStat(String location, String quantity) Read specified entry in DAQ Rds Stats for specified location
String	readRmsStat(String location, String quantity) Read specified entry in DAQ Rms Stats for specified location
String	timestamp() Determines current time G *
void	validateBulkChange(Map<String,Object> params) Checks validity of a proposed set of ConfigurationParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

postBuild, postInit, postShutdown, postStart, shutdown, start

Methods inherited from interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

setParameterBulk

Methods inherited from interface org.lsst.ccs.services.HasDataProviderInfos

finalizeDictionary

Field Detail

sumDriverStats

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=15,
                        description="Driver Stats for sums over location")
protected volatile List<String> sumDriverStats

sumFirmwareStats

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=30,
                        description="Firmware Stats for sums over location")
protected volatile List<String> sumFirmwareStats

sumRdsStats

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=15,
                        description="Rds Stats for sums over location")
protected volatile List<String> sumRdsStats

sumRmsStats

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=15,
                        description="Rms Stats for sums over location")
protected volatile List<String> sumRmsStats

sumDriverChecks

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=15,
                        description="Driver Stats for warnings on sums")
protected volatile List<String> sumDriverChecks

sumFirmwareChecks

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=30,
                        description="Firmware Stats for warnings on sums")
protected volatile List<String> sumFirmwareChecks

sumRdsChecks

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=15,
                        description="Rds Stats for warnings on sums")
protected volatile List<String> sumRdsChecks

sumRmsChecks

@ConfigurationParameter(isFinal=true,
                        category="Statistics",
                        maxLength=15,
                        description="Rms Stats for warnings on sums")
protected volatile List<String> sumRmsChecks

minDiffLogWarning

@ConfigurationParameter(category="Statistics",
                        description="minimum difference between successive reads to put warning in log")
protected volatile Integer minDiffLogWarning

minDiffAlertWarning

@ConfigurationParameter(category="Statistics",
                        description="minimum difference between successive reads to raise Alert at warning level")
protected volatile Integer minDiffAlertWarning

Constructor Detail

DaqStatsMonitor

public DaqStatsMonitor()

Constructor

Method Detail

isOnline

public boolean isOnline()

Gets the online state.

Returns:

Whether or not the device is online

build

public void build()

build phase: set up periodic task for publication

Specified by:

build in interface org.lsst.ccs.framework.HasLifecycle

init

public void init()

init phase: open connection to DAQ partition Also, use first Daq location to verify ConfigurationParameter Lists

Specified by:

init in interface org.lsst.ccs.framework.HasLifecycle

Throws:

org.lsst.ccs.daq.ims.DAQException

validateBulkChange

public void validateBulkChange(Map<String,Object> params)

Checks validity of a proposed set of ConfigurationParameters

Specified by:

validateBulkChange in interface org.lsst.ccs.config.ConfigurationBulkChangeHandler

Parameters:

params - Map of ConfigurationParameters from name to value

getDataProviderInfos

public List<org.lsst.ccs.bus.data.DataProviderInfo> getDataProviderInfos()

This method of HasDataProviderInfo is used to register summed data, including units, for publication.

Specified by:

getDataProviderInfos in interface org.lsst.ccs.services.HasDataProviderInfos

Returns:

List

publishDataProviderCurrentData

public void publishDataProviderCurrentData(org.lsst.ccs.bus.data.AgentInfo a)

Not used, but present to complete HasDataProviderInfos interace

Specified by:

publishDataProviderCurrentData in interface org.lsst.ccs.services.HasDataProviderInfos

readAllStats

@Command(type=QUERY,
         name="readAllStats",
         level=0,
         description="Read all sets of DAQ stats")
public String readAllStats(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                   String location)
                                                                                                                                            throws org.lsst.ccs.daq.ims.DAQException

Print all four sets of statisics for specified location

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

clearAllStats

@Command(type=ACTION,
         name="clearAllStats",
         level=1,
         description="Read and clear all sets of DAQ stats for location")
public String clearAllStats(@Argument(name="location",description="clearout board in format R<nn>/Reb<m>")
                                                                                                                                                                             String location)
                                                                                                                                                                      throws org.lsst.ccs.daq.ims.DAQException

Print then clear all four sets of statisics for specified location

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

clearStatsAllLocations

@Command(type=ACTION,
         name="clearStatsAllLocations",
         level=1,
         description="Clear all DAQ stats for all locations")
public String clearStatsAllLocations()
                                                                                                                                                                            throws org.lsst.ccs.daq.ims.DAQException

Clear all four sets of statisics for all locations

Returns:

String Informational message, not actual data read

Throws:

org.lsst.ccs.daq.ims.DAQException

readAllRms

@Command(type=QUERY,
         name="readAllRms",
         level=0,
         description="Read all DAQ Rms stats")
public String readAllRms(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                           String location)
                                                                                                                                    throws org.lsst.ccs.daq.ims.DAQException

Print all DAQ Rms statistics data for specified Location Reads all DAQRmsStatistics values and return them in table format.

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

readAllRds

@Command(type=QUERY,
         name="readAllRds",
         level=0,
         description="Read all DAQ Rds stats")
public String readAllRds(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                           String location)
                                                                                                                                    throws org.lsst.ccs.daq.ims.DAQException

Print all DAQ Rds statistics data for specified Location Reads all DAQRdsStatistics values and return them in table format.

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

readAllDriver

@Command(type=QUERY,
         name="readAllDriver",
         level=0,
         description="Read all DAQ Driver stats")
public String readAllDriver(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                    String location)
                                                                                                                                             throws org.lsst.ccs.daq.ims.DAQException

Print all DAQ Driver statistics data for specified Location Reads all DAQDriverStatistics values and return them in table format.

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

readAllFirmware

@Command(type=QUERY,
         name="readAllFirmware",
         level=0,
         description="Read all DAQ Firmware stats")
public String readAllFirmware(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                          String location)
                                                                                                                                                   throws org.lsst.ccs.daq.ims.DAQException

Print all DAQ Firmware statistics data for specified Location Reads all DAQFirmwareStatistics values and return them in table format.

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

clearAllRms

@Command(type=ACTION,
         name="clearAllRms",
         level=1,
         description="Read and clear DAQ Rms stats")
public String clearAllRms(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                    String location)
                                                                                                                                             throws org.lsst.ccs.daq.ims.DAQException

Print and Clear all DAQ Rms statistics data for specified Location Like readAllRms, but clears data after reading

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

clearAllRds

@Command(type=ACTION,
         name="clearAllRds",
         level=1,
         description="Read and clear DAQ Rds stats")
public String clearAllRds(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                    String location)
                                                                                                                                             throws org.lsst.ccs.daq.ims.DAQException

Print and Clear all DAQ Rds statistics data for specified Location Like readAllRds, but clears data after reading

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

clearAllDriver

@Command(type=ACTION,
         name="clearAllDriver",
         level=1,
         description="Read and clear DAQ Driver stats")
public String clearAllDriver(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                             String location)
                                                                                                                                                      throws org.lsst.ccs.daq.ims.DAQException

Print and Clear all DAQ Driver statistics data for specified Location Like readAllDriver, but clears data after reading

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

clearAllFirmware

@Command(type=ACTION,
         name="clearAllFirmware",
         level=1,
         description="Read and clear DAQ Firmware stats")
public String clearAllFirmware(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                                   String location)
                                                                                                                                                            throws org.lsst.ccs.daq.ims.DAQException

Print and Clear all DAQ Firmware statistics data for specified Location Like readAllFirmware, but clears data after reading

Parameters:

location - Location in raft/board format, "R/Reb"

Returns:

String reporting all data read

Throws:

org.lsst.ccs.daq.ims.DAQException

readRmsStat

@Command(type=QUERY,
         name="readRmsStat",
         level=0,
         description="read specified DAQ Rms statistic for specified locaation")
public String readRmsStat(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                                               String location,
                                                                                                                                                                               @Argument(name="statistic name")
                                                                                                                                                                               String quantity)
                                                                                                                                                                        throws org.lsst.ccs.daq.ims.DAQException

Read specified entry in DAQ Rms Stats for specified location

Parameters:

location - Location in raft/board format, "R/Reb"

name - Name of requested quantity

Returns:

Value of requested quantity

Throws:

org.lsst.ccs.daq.ims.DAQException

readRdsStat

@Command(type=QUERY,
         name="readRdsStat",
         level=0,
         description="read specified DAQ Rds statistic for specified locaation")
public String readRdsStat(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                                               String location,
                                                                                                                                                                               @Argument(name="statistic name")
                                                                                                                                                                               String quantity)
                                                                                                                                                                        throws org.lsst.ccs.daq.ims.DAQException

Read specified entry in DAQ Rds Stats for specified location

Parameters:

location - Location in raft/board format, "R/Reb"

name - Name of requested quantity

Returns:

Value of requested quantity

Throws:

org.lsst.ccs.daq.ims.DAQException

readDriverStat

@Command(type=QUERY,
         name="readDriverStat",
         level=0,
         description="read specified DAQ Driver statistic for specified locaation")
public String readDriverStat(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                                                        String location,
                                                                                                                                                                                        @Argument(name="statistic name")
                                                                                                                                                                                        String quantity)
                                                                                                                                                                                 throws org.lsst.ccs.daq.ims.DAQException

Read specified entry in DAQ Driver Stats for specified location

Parameters:

location - Location in raft/board format, "R/Reb"

name - Name of requested quantity

Returns:

Value of requested quantity

Throws:

org.lsst.ccs.daq.ims.DAQException

readFirmwareStat

@Command(type=QUERY,
         name="readFirmwareStat",
         level=0,
         description="read specified DAQ Firmware statistic for specified locaation")
public String readFirmwareStat(@Argument(name="location",description="readout board in format R<nn>/Reb<m>")
                                                                                                                                                                                              String location,
                                                                                                                                                                                              @Argument(name="statistic name")
                                                                                                                                                                                              String quantity)
                                                                                                                                                                                       throws org.lsst.ccs.daq.ims.DAQException

Read specified entry in DAQ Firmware Stats for specified location

Parameters:

location - Location in raft/board format, "R/Reb"

name - Name of requested quantity

Returns:

Value of requested quantity

Throws:

org.lsst.ccs.daq.ims.DAQException

timestamp

@Command(name="timestamp",
         description="Prints current time",
         type=QUERY,
         level=0)
public String timestamp()

Determines current time G *

Returns:

current time as a String