org.lsst.ccs.subsystem.monitor

Class Device

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Device

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable

Direct Known Subclasses:

CalcDevice

public abstract class Device
extends org.lsst.ccs.framework.ConfigurableComponent

Handles hardware devices

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
protected BitSet	chanMask
protected Map<String,Control>	ctlChans
protected String	fullName Data fields.
protected boolean	inited
protected int	lineMask
protected int	lineState
protected int	lineWarm
protected Logger	log
protected Monitor	mon
protected boolean	online

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

environment

Constructor Summary

Constructors

Constructor and Description
Device()

Method Summary

Modifier and Type	Method and Description
protected void	addChannel(int id) Adds a channel to the device's list of monitored channels.
protected void	addConfigValues(Map<String,Object> map) Adds to the map of configured items.
protected void	addLine(int line) Adds an output line to the known list.
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a monitor channel's parameters for validity.
protected void	checkHwLine(String name, int line) Checks the validity of an output line.
protected void	checkLine(String name, int line) Checks the validity of an output line.
protected void	checkOnline() Checks the online state.
protected void	checkTimeout(Exception e, Class<?> eClass) Checks whether exception is a timeout.
protected abstract void	close() Closes the connection.
protected void	configure(Monitor mon) Performs common configuration.
protected void	dropChannel(int id) Drops a channel from the device's list of monitored channels.
Map<String,Object>	getConfigValues() Gets the map of configured items.
String	getFullName() Gets the full name.
protected void	getOutputLines() Gets the states of all output lines and saves them.
protected void	initChannel(int hwChan, int type, int subtype) Initializes a monitor channel.
protected abstract void	initialize() Performs hardware initialization.
protected void	initSensors() Initializes all attached sensors.
protected boolean	isHwLineSet(int line) Gets an output line set state.
protected boolean	isLineSet(int line) Gets an output line set state.
boolean	isOnline() Gets the online state.
protected boolean	isTimeout(Exception e) Tests whether exception is a timeout.
protected double	readChannel(int hwChan, int type) Reads a monitor channel.
protected void	readChannelGroup() Reads the monitor channel group.
protected void	readSensors() Reads all attached sensors (monitor channels).
protected void	setHwLine(int line, boolean on) Sets an output line on or off.
protected void	setLine(int line, boolean on) Sets an output line on or off.
protected void	setLineWarm(int line, boolean on) Sets the warm-start state of an output line.
protected void	setOnline(boolean online) Sets the online state.
protected void	setOutputLines() Sets all output lines from the saved state.
protected boolean	testOnline() Tests the online state.

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent

getChildren, getEnvironment, setEnvironment

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.Configurable

alias, change, getCheckedValueFromConfiguration, getComponentByName, getDictionary, getName, getParent, getParentObject, getSubsystem, init, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, proceduralWalk, publish, publish, publish, publish, publish, publish, shutdownNow, start, treeWalk

Field Detail

fullName

protected String fullName

Data fields.

chanMask

protected BitSet chanMask

inited

protected boolean inited

online

protected boolean online

mon

protected Monitor mon

log

protected Logger log

ctlChans

protected Map<String,Control> ctlChans

lineMask

protected int lineMask

lineWarm

protected int lineWarm

lineState

protected int lineState

Constructor Detail

Device

public Device()

Method Detail

getFullName

public String getFullName()

Gets the full name.

Returns:

The full name of the device

isOnline

public boolean isOnline()

Gets the online state.

Returns:

Whether or not the device is online

configure

protected void configure(Monitor mon)

Performs common configuration. Can be overridden if necessary, but must be called by overriding code.

Parameters:

mon - The associated monitor

getConfigValues

@Command(type=QUERY,
         description="Gets map of configured items")
public Map<String,Object> getConfigValues()

Gets the map of configured items.

Returns:

A map of the configured items linking name and value.

checkChannel

protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a monitor channel's parameters for validity. This method is to be overridden for devices with monitor channels that have descriptive information to be checked and encoded.

Parameters:

name - The name of the channel.

hwChan - The hardware channel number.

type - The channel type string.

subtype - The channel subtype string.

Returns:

A two-element array containing the encoded type [0] and subtype [1].

Throws:

Exception - if any errors found in the parameters

initialize

protected abstract void initialize()

Performs hardware initialization.

close

protected abstract void close()

Closes the connection.

initSensors

protected void initSensors()

Initializes all attached sensors.

initChannel

protected void initChannel(int hwChan,
                           int type,
                           int subtype)

Initializes a monitor channel. This method is to be overridden for devices with monitor channels that need to be configured in the hardware.

Parameters:

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

subtype - The channel subtype returned by checkChannel.

addChannel

protected void addChannel(int id)

Adds a channel to the device's list of monitored channels.

Parameters:

id - The id of the channel.

dropChannel

protected void dropChannel(int id)

Drops a channel from the device's list of monitored channels.

Parameters:

id - The id of the channel.

checkOnline

protected void checkOnline()

Checks the online state. If offline, an attempt is made to re-initialize the device.

testOnline

protected boolean testOnline()

Tests the online state. If offline, an error message is logged.

Returns:

Whether or not the device is online.

setOnline

protected void setOnline(boolean online)

Sets the online state. If the device is set offline, an error message is logged.

Parameters:

online - The online state to set: true or false

readSensors

protected void readSensors()

Reads all attached sensors (monitor channels).

readChannelGroup

protected void readChannelGroup()

Reads the monitor channel group. This method is to be overridden for devices that reads some (or all) of its monitor channels at one time.

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a monitor channel. This method is to be overridden for devices with monitor channels.

Parameters:

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

Returns:

The value read from the channel

addConfigValues

protected void addConfigValues(Map<String,Object> map)

Adds to the map of configured items. This method is to be overridden if necessary

Parameters:

map - The map of configured items to be added to

checkTimeout

protected void checkTimeout(Exception e,
                            Class<?> eClass)
                     throws Exception

Checks whether exception is a timeout. If it is a timeout, the device is set offline. In all cases an exception of the supplied class is thrown, containing the message of the original exception.

Parameters:

e - The exception to be checked.

eClass - The class of the exception to be thrown.

Throws:

Exception

isTimeout

protected boolean isTimeout(Exception e)

Tests whether exception is a timeout.

Parameters:

e - The exception to be tested.

Returns:

Whether or not the exception is a timeout.

checkLine

protected void checkLine(String name,
                         int line)
                  throws Exception

Checks the validity of an output line.

Parameters:

name - The name of the output line.

line - The hardware line number of the output line.

Throws:

Exception - if the line number is invalid.

checkHwLine

protected void checkHwLine(String name,
                           int line)
                    throws Exception

Checks the validity of an output line. This method is to be overridden for devices with output lines.

Parameters:

name - The name of the output line.

line - The hardware line number of the output line.

Throws:

Exception - if the line number is invalid.

setLineWarm

protected void setLineWarm(int line,
                           boolean on)

Sets the warm-start state of an output line.

Parameters:

line - The output line number.

on - The warm-start on state to set: true or false

setLine

protected void setLine(int line,
                       boolean on)

Sets an output line on or off.

Parameters:

line - The output line number.

on - The on state to set: true or false

setHwLine

protected void setHwLine(int line,
                         boolean on)

Sets an output line on or off. This method is to be overridden for devices with output lines.

Parameters:

line - The output line number.

on - The on state to set: true or false

isLineSet

protected boolean isLineSet(int line)

Gets an output line set state.

Parameters:

line - The output line number.

Returns:

Whether or not the line is set.

isHwLineSet

protected boolean isHwLineSet(int line)

Gets an output line set state. This method is to be overridden for devices with output lines.

Parameters:

line - The output line number.

Returns:

Whether or not the line is set.

setOutputLines

protected void setOutputLines()

Sets all output lines from the saved state.

getOutputLines

protected void getOutputLines()

Gets the states of all output lines and saves them.

addLine

protected void addLine(int line)

Adds an output line to the known list.

Parameters:

line - The output line number.