org.lsst.ccs.subsystem.monitor

Class MonitorCommands

java.lang.Object

org.lsst.ccs.subsystem.monitor.MonitorCommands

public class MonitorCommands
extends Object

A Class containing Monitor level commands. This class is intended to be added to an Agent command dictionary to provide basic Monitor commands to interact with the underlying Monitor framework.

Author:

turri

Constructor Summary

Constructors

Constructor and Description
MonitorCommands(Monitor mon) Public constructor for MonitoringCommands.

Method Summary

Modifier and Type	Method and Description
List<String>	getChannelNames() Gets the list of channel names.
double	getChannelValue(String name) Gets a channel value.
Map<String,Object>	getConfigurationMap() Gets the map of configured values from all devices.
List<String>	getDeviceNames() Gets the list of all device names.
double	readChannelValue(String name) Reads a channel value.
void	saveLimits() Saves the monitoring limits.

Methods inherited from class java.lang.Object

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

Constructor Detail

MonitorCommands

public MonitorCommands(Monitor mon)

Public constructor for MonitoringCommands.

Parameters:

mon - The Monitor object on which the commands will be executed.

Method Detail

saveLimits

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

Saves the monitoring limits.

Throws:

IOException

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

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(@Argument(name="name",description="Channel name")
                                                                                               String name)

Gets a channel value.

Parameters:

name - The channel name

Returns:

The last-read channel value

Throws:

IllegalArgumentException - if the channel doesn't exist

readChannelValue

@Command(type=QUERY,
         description="Read a channel value")
public double readChannelValue(@Argument(name="name",description="Channel name")
                                                                                                 String name)

Reads a channel value.

Parameters:

name - The channel name

Returns:

The read channel value, or NaN if the data isn't available

Throws:

IllegalArgumentException - if the channel doesn't exist

getConfigurationMap

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

Gets the map of configured values from all devices.

Returns:

The map of configured values