org.lsst.ccs.monitor

Class Monitor

java.lang.Object

org.lsst.ccs.monitor.Monitor

All Implemented Interfaces:

HasLifecycle

Direct Known Subclasses:

Monitor, Monitor

public class Monitor
extends Object
implements HasLifecycle

Author:

emarin

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Monitor.AlarmHandler	alarmH TODO make package protected
protected Logger	log
static String	MONITOR_CHECK_TASK
static String	MONITOR_PUBLISH_TASK
static String	MONITOR_UPDATE_TASK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Monitor()
protected	Monitor(Agent a, Monitor.AlarmHandler alarmHand)
	Monitor(Subsystem a) Base Monitor framework 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.
Monitor.AlarmHandler	getAlarmHandler() Here for tests
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() Deprecated. use the configuration framework instead
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.
MonitorFullState	getMonitorFullState()
int	getNumChans() Gets the number of channels.
void	init() Called from the enclosing Subsystem at construction phase.
void	initConfiguration() Deprecated. The subsystem's monitor should be used instead.
void	initSensors() Deprecated. This method is no longer needed LSSTCCS-103
void	initSensors(int checkPeriod) Deprecated. This method is no longer needed LSSTCCS-1032
void	postStart() Called from the enclosing Subsystem after HardwareController components have been handled.
void	publishData() Deprecated. the monitor provides a dedicated timer task to publish monitored quantities. The period is controlled by the configuration parameter monitor_PublishData/taskPeriodMillis
void	publishLimits() Deprecated. this method can be safely removed, the monitor publishes the limits in its post-start implementation.
void	publishState() Deprecated. this method can be safely removed, the monitor publishes its state in its poststart implementation.
Double	readChannelValue(String name) Reads a monitored channel value.
void	readSensors() Reads the sensor data.
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(int period) Deprecated. This method is no longer needed LSSTCCS-1032
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

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

postInit, postShutdown, shutdownNow, start

Field Detail

alarmH

@LookupField(strategy=TREE)
protected Monitor.AlarmHandler alarmH

TODO make package protected

log

protected Logger log

MONITOR_CHECK_TASK

public static final String MONITOR_CHECK_TASK

See Also:

Constant Field Values

MONITOR_UPDATE_TASK

public static final String MONITOR_UPDATE_TASK

See Also:

Constant Field Values

MONITOR_PUBLISH_TASK

public static final String MONITOR_PUBLISH_TASK

See Also:

Constant Field Values

Constructor Detail

Monitor

public Monitor(Subsystem a)

Base Monitor framework constructor

Parameters:

a - The Agent that will own the Monitor framework,

Monitor

protected Monitor()

Monitor

protected Monitor(Agent a,
                  Monitor.AlarmHandler alarmHand)

Method Detail

init

public void init()

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem at construction phase. This method is called before the children components of this object have their init method called. At the time it is called, connection to the messaging layer is not yet done, so there should be no attempt to send messages in the body of this method. Configuration for message listening can nevertheless be done here, such as adding MessageListener objects.

It is unnecessary to call super.init()

Specified by:

init in interface HasLifecycle

initConfiguration

@Deprecated
public void initConfiguration()

Deprecated. The subsystem's monitor should be used instead.

Initializes the monitoring configuration.

initSensors

@Deprecated
public void initSensors()

Deprecated. This method is no longer needed LSSTCCS-103

Initializes the monitoring sensors.

initSensors

@Deprecated
public void initSensors(int checkPeriod)

Deprecated. This method is no longer needed LSSTCCS-1032

Initializes the monitoring sensors.

Parameters:

checkPeriod - The online check period (ms)

readSensors

public void readSensors()

Reads the sensor data.

start

@Deprecated
public void start(int period)

Deprecated. This method is no longer needed LSSTCCS-1032

Starts monitoring.

Parameters:

period - The update period (ms)

postStart

public void postStart()
               throws HardwareException

Description copied from interface: HasLifecycle

Called from the enclosing Subsystem after HardwareController components have been handled. At the time it is called :

• HardwareController components have been handled without throwing HardwareException

If successful, the enclosing subsystem's PhaseState will change to OPERATIONAL and the subsystem will invoke startTicking on its modules components.

If an HardwareException is thrown, the OperationalState will change to ENGINEERING_FAULT until a call to completeInitialization is successful

It is unnecessary to call super.postStart() TO-DO: Does this really need to throw a HardwareException? Don't we have other Hardware specific interfaces?

Specified by:

postStart in interface HasLifecycle

Throws:

HardwareException - if any failure interacting with the hardware occurs.

getFullState

public MonitorFullState getFullState()

Gets the full monitoring state.

Returns:

The full monitoring state, as needed by GUIs

getMonitorFullState

@Command(type=QUERY,
         description="Get the full monitoring state")
public MonitorFullState getMonitorFullState()

publishState

@Deprecated
public void publishState()

Deprecated. this method can be safely removed, the monitor publishes its state in its poststart implementation.

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

publishData

@Deprecated
public void publishData()

Deprecated. the monitor provides a dedicated timer task to publish monitored quantities. The period is controlled by the configuration parameter monitor_PublishData/taskPeriodMillis

Publishes all the data values of the monitoring module.

publishLimits

@Deprecated
public void publishLimits()

Deprecated. this method can be safely removed, the monitor publishes the limits in its post-start implementation.

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

@Command(type=QUERY,
         description="Get the list of all devices")
public List<String> getDeviceNames()

Gets the list of all device names.

Returns:

The list of device names

getConfigurationMap

@Deprecated
 @Command(type=QUERY,
         description="Get the map of all configured values")
public Map<String,Object> getConfigurationMap()

Deprecated. use the configuration framework instead

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

@Command(type=QUERY,
         description="Get the list of channel names")
public List<String> getChannelNames()

Gets the list of channel names.

Returns:

The list of channel names

getChannelValue

@Command(type=QUERY,
         description="Get a channel value")
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

@Command(type=QUERY,
         description="Read a channel value")
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

saveLimits

@Command(type=ACTION,
         description="Save the monitoring limits")
public void saveLimits()

Saves the limit values.

getAlarmHandler

public Monitor.AlarmHandler getAlarmHandler()

Here for tests