org.lsst.ccs.subsystem.monitor

Class Monitor

java.lang.Object

org.lsst.ccs.subsystem.monitor.Monitor

public class Monitor
extends Object

Implements monitoring.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Monitor.AlarmHandler Interface for handling alarm events.

Constructor Summary

Constructors

Constructor and Description
Monitor(org.lsst.ccs.framework.Module mod, Monitor.AlarmHandler alarmHand, Logger logger) Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkLimits() Deprecated.
void	clearLimitChanges() Clears limits-changed indicators.
Alarm	getAlarm(String name) Gets the alarm with the given name.
Channel	getChannel(int id) Gets the channel with the given ID.
Channel	getChannel(String name) Gets the channel with the given name.
int	getChannelId(String name) Gets the ID of the channel with the given name.
List<String>	getChannelNames() Gets the list of channel names.
Double	getChannelValue(String name) Gets a monitored channel value.
Map<String,Object>	getConfigurationMap() Gets the map of configured values from all devices.
Device	getDevice(String name) Gets the device with the given name.
List<String>	getDeviceNames() Gets the list of all device names.
MonitorFullState	getFullState() Gets the full monitoring state.
Line	getLine(String name) Gets the line with the given name.
org.lsst.ccs.framework.Module	getModule() Gets the associated module.
int	getNumChans() Gets the number of channels.
void	initConfiguration() Initializes the monitoring configuration.
void	initSensors() Initializes the monitoring sensors.
void	initSensors(int checkPeriod) Initializes the monitoring sensors.
void	publishData() Publishes all the data values of the monitoring module.
void	publishLimits() Publishes all the limit values of the monitoring module.
void	publishState() Publishes the state of the monitoring module.
Double	readChannelValue(String name) Reads a monitored channel value.
void	readSensors() Reads the sensor data.
void	reportConfigError(String cName, String pName, String message) Reports configuration parameter error and exits.
void	reportError(String cName, String pName) Reports missing parameter error.
void	reportError(String cName, String pName, Object pValue) Reports invalid parameter value error.
void	saveLimits() Saves the limit values.
void	setOnline(BitSet mask, boolean online) Sets channels on- or off-line.
void	setPublishData() Sets the publish data flag.
void	start() Starts monitoring.
void	start(int period) Starts monitoring.
void	updateState() Updates the state of the monitoring system.

Methods inherited from class java.lang.Object

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

Constructor Detail

Monitor

public Monitor(org.lsst.ccs.framework.Module mod,
               Monitor.AlarmHandler alarmHand,
               Logger logger)

Constructor.

Parameters:

mod - The associated module

alarmHand - The associated alarm handler

logger - The associated logger

Method Detail

initConfiguration

public void initConfiguration()

Initializes the monitoring configuration.

initSensors

public void initSensors()

Initializes the monitoring sensors.

initSensors

public void initSensors(int checkPeriod)

Initializes the monitoring sensors.

Parameters:

checkPeriod - The online check period (ms)

readSensors

public void readSensors()

Reads the sensor data.

start

public void start()

Starts monitoring.

start

public void start(int period)

Starts monitoring.

Parameters:

period - The update period (ms)

getFullState

public MonitorFullState getFullState()

Gets the full monitoring state.

Returns:

The full monitoring state, as needed by GUIs

publishState

public void publishState()

Publishes the state of the monitoring module. This is intended to be called whenever any element of the state is changed.

publishData

public void publishData()

Publishes all the data values of the monitoring module.

publishLimits

public void publishLimits()

Publishes all the limit values of the monitoring module. This is intended to be called at startup time.

updateState

public void updateState()

Updates the state of the monitoring system. This checks whether all current channel values are within limits, activates any resulting alarms, checks for any changes in online channels, and reports any changes on the status bus.

checkLimits

@Deprecated
public void checkLimits()

Deprecated.

setPublishData

public void setPublishData()

Sets the publish data flag.

clearLimitChanges

public void clearLimitChanges()

Clears limits-changed indicators.

getDevice

public Device getDevice(String name)

Gets the device with the given name.

Parameters:

name - The device name

Returns:

The matching device, or null if not found

getDeviceNames

public List<String> getDeviceNames()

Gets the list of all device names.

Returns:

The list of device names

getConfigurationMap

public Map<String,Object> getConfigurationMap()

Gets the map of configured values from all devices.

Returns:

The map of configured values

getLine

public Line getLine(String name)

Gets the line with the given name.

Parameters:

name - The line name

Returns:

The matching line, or null if not found

getAlarm

public Alarm getAlarm(String name)

Gets the alarm with the given name.

Parameters:

name - The alarm name

Returns:

The matching alarm, or null if not found

getChannel

public Channel getChannel(String name)

Gets the channel with the given name.

Parameters:

name - The channel name

Returns:

The matching channel, or null if not found

getChannel

public Channel getChannel(int id)

Gets the channel with the given ID.

Parameters:

id - The channel ID

Returns:

The matching channel

getChannelId

public int getChannelId(String name)

Gets the ID of the channel with the given name.

Parameters:

name - The channel name

Returns:

The ID of the matching channel, or -1 if not found

setOnline

public void setOnline(BitSet mask,
                      boolean online)

Sets channels on- or off-line.

Parameters:

mask - Mask of affected channels

online - True if channels to be set online, false otherwise

getNumChans

public int getNumChans()

Gets the number of channels.

Returns:

The number of channels

getChannelNames

public List<String> getChannelNames()

Gets the list of channel names.

Returns:

The list of channel names

getChannelValue

public Double getChannelValue(String name)

Gets a monitored channel value.

Parameters:

name - The channel name

Returns:

The last-read channel value, or null if the name is unknown

readChannelValue

public Double readChannelValue(String name)

Reads a monitored channel value.

Parameters:

name - The channel name

Returns:

The read channel value, NaN if the data isn't available, or null if the name is unknown

getModule

public org.lsst.ccs.framework.Module getModule()

Gets the associated module.

Returns:

The module

saveLimits

public void saveLimits()

Saves the limit values.

reportError

public void reportError(String cName,
                        String pName,
                        Object pValue)
                 throws Exception

Reports invalid parameter value error.

Parameters:

cName - The component name

pName - The parameter name

pValue - The parameter value

Throws:

Exception, - always

Exception

reportError

public void reportError(String cName,
                        String pName)
                 throws Exception

Reports missing parameter error.

Parameters:

cName - The component name

pName - The parameter name

Throws:

Exception, - always

Exception

reportConfigError

public void reportConfigError(String cName,
                              String pName,
                              String message)

Reports configuration parameter error and exits.

Parameters:

cName - The component name

pName - The parameter name

message - The message to log