org.lsst.ccs.subsystem.utility

Class PduCommonDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.utility.PduCommonDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, SwitchControl

Direct Known Subclasses:

PduHVDevice

public class PduCommonDevice
extends org.lsst.ccs.monitor.Device
implements SwitchControl

Interface to a SLAC PDU. This class is designed only to be extended, not instantiated itself

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG Constants.
protected static int	MON_TYPE_CURRENT
protected static int	MON_TYPE_VOLTAGE
protected Integer	node Data fields.

Fields inherited from class org.lsst.ccs.monitor.Device

alertOfflineId, alertService, configService, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, path, s

Constructor Summary

Constructors

Constructor and Description
PduCommonDevice(org.lsst.ccs.drivers.auxelex.PduCommon pdu, String pduType, int swDevc) Constructor.

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a monitoring channel's parameters for validity.
protected void	close() Closes the connection.
int	getSwitchDevice() Gets the switch device type
protected void	initDevice() Performs configuration.
protected void	initialize() Performs full initialization.
Boolean	isSwitchOn(int chan) Gets the state of a PDU channel.
protected double	readChannel(int hwChan, int type) Reads a monitoring channel.
void	switchOff(int chan) Turns a PDU channel off.
void	switchOn(int chan) Turns a PDU channel on.

Methods inherited from class org.lsst.ccs.monitor.Device

addLine, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getDeviceMonitorUpdateTasks, getFullName, getGroupForChannel, getMonitorUpdateTasksForChannels, getName, getOutputLines, getPath, init, initChannel, initChannel, initSensors, isEnabled, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelGroup, readChannelNow, setDisabled, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, start, testOnline

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

build, postBuild, postInit, postShutdown, postStart, shutdown

Field Detail

LOG

protected static final Logger LOG

Constants.

MON_TYPE_VOLTAGE

protected static final int MON_TYPE_VOLTAGE

See Also:

Constant Field Values

MON_TYPE_CURRENT

protected static final int MON_TYPE_CURRENT

See Also:

Constant Field Values

node

@ConfigurationParameter(name="node",
                        category="Util",
                        isFinal=true)
protected volatile Integer node

Data fields.

Constructor Detail

PduCommonDevice

public PduCommonDevice(org.lsst.ccs.drivers.auxelex.PduCommon pdu,
                       String pduType,
                       int swDevc)

Constructor.

Parameters:

pdu - The PDU driver object

pduType - The PDU type description

swDevc - The switch device ID

Method Detail

initDevice

protected void initDevice()

Performs configuration.

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Performs full initialization.

Specified by:

initialize in class org.lsst.ccs.monitor.Device

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.monitor.Device

checkChannel

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

Checks a monitoring channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.monitor.Device

Parameters:

name - The channel name

hwChan - The hardware channel

type - The channel type string

subtype - The channel subtype string

Returns:

Two-element array containing the encoded type [0] and subtype [1]

Throws:

Exception - If parameters are invalid

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a monitoring channel.

Overrides:

readChannel in class org.lsst.ccs.monitor.Device

Parameters:

hwChan - The hardware channel number

type - The encoded channel type

Returns:

The read value

getSwitchDevice

public int getSwitchDevice()

Gets the switch device type

Specified by:

getSwitchDevice in interface SwitchControl

Returns:

The switch device type

switchOn

public void switchOn(int chan)

Turns a PDU channel on.

Specified by:

switchOn in interface SwitchControl

Parameters:

chan - The channel number

switchOff

public void switchOff(int chan)

Turns a PDU channel off.

Specified by:

switchOff in interface SwitchControl

Parameters:

chan - The channel number

isSwitchOn

public Boolean isSwitchOn(int chan)

Gets the state of a PDU channel.

Specified by:

isSwitchOn in interface SwitchControl

Parameters:

chan - The channel number

Returns:

Whether the channel is on or off