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, org.lsst.ccs.utilities.logging.Logger logger) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkLimits() Checks whether all current channel values are within limits.
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.
Device	getDevice(String name) Gets the device with the given name.
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	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.
void	readSensors() Reads the sensor data.
void	reportConfigError(String cName, String pName, String message) Reports configuration parameter errors and exits.
void	reportError(String cName, String pName, Object pValue) Reports parameter errors.
void	setOnline(BitSet mask, boolean online) Sets channels on- or off-line.
void	start() Starts monitoring.
void	start(long period)

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,
       org.lsst.ccs.utilities.logging.Logger logger)

Constructor.

Method Detail

initConfiguration

public void initConfiguration()

Initializes the monitoring configuration.

initSensors

public void initSensors()

Initializes the monitoring sensors.

readSensors

public void readSensors()

Reads the sensor data.

start

public void start()

Starts monitoring.

start

public void start(long period)

getFullState

public MonitorFullState getFullState()

Gets the full monitoring state.

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.

checkLimits

public void checkLimits()

Checks whether all current channel values are within limits.

clearLimitChanges

public void clearLimitChanges()

Clears limits-changed indicators.

getDevice

public Device getDevice(String name)

Gets the device with the given name.

getLine

public Line getLine(String name)

Gets the line with the given name.

getAlarm

public Alarm getAlarm(String name)

Gets the alarm with the given name.

getChannel

public Channel getChannel(String name)

Gets the channel with the given name.

getChannel

public Channel getChannel(int id)

Gets the channel with the given ID.

getChannelId

public int getChannelId(String name)

Gets the ID of the channel with the given name.

setOnline

public void setOnline(BitSet mask,
             boolean online)

Sets channels on- or off-line.

getNumChans

public int getNumChans()

Gets the number of channels.

getModule

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

Gets the associated module.

reportError

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

Reports parameter errors.

Throws:

Exception

reportConfigError

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

Reports configuration parameter errors and exits.