org.lsst.ccs.subsystem.vacuum

Class VacPlutoDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.vacuum.VacPlutoDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle

public class VacPlutoDevice
extends org.lsst.ccs.monitor.Device

Handles the vacuum system Pluto PLC.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUM_SWITCHES Constants.
static int	SW_BLOCK_CVPUMP Constants.
static int	SW_BLOCK_CVSTAT Constants.
static int	SW_BLOCK_HVPUMP Constants.
static int	SW_BLOCK_HVSTAT Constants.
static int	SW_OPEN_VCR00 Constants.
static int	SW_OPEN_VCR01 Constants.
static int	SW_OPEN_VCR02 Constants.
static int	SW_OPEN_VCR03 Constants.
static int	SW_OPEN_VCR04 Constants.
static int	SW_OPEN_VHX00 Constants.

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

chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, s

Constructor Summary

Constructors

Constructor and Description
VacPlutoDevice()

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
void	clearCondition(int cond) Clears a condition.
protected void	close() Closes the connection.
List<Integer>	getConditionIds() Gets the list of conditions in use.
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
Boolean	isConditionActive(int cond) Gets whether a condition is active.
Boolean	isConditionLatched(int cond) Gets whether a condition is latched.
Boolean	isSwitchOn(int sw) Gets the on state of a switch.
protected double	readChannel(int hwChan, int type) Reads a channel.
protected void	readChannelGroup() Reads all referenced channels.
void	setSwitchOn(int sw, boolean on) Sets a switch on or off.

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

addChannel, addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getFullName, getName, getOutputLines, init, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelNow, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, 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.HardwareController

checkStarted, checkStopped

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

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

SW_BLOCK_HVSTAT

public static final int SW_BLOCK_HVSTAT

Constants.

See Also:

Constant Field Values

SW_BLOCK_CVSTAT

public static final int SW_BLOCK_CVSTAT

Constants.

See Also:

Constant Field Values

SW_OPEN_VHX00

public static final int SW_OPEN_VHX00

Constants.

See Also:

Constant Field Values

SW_OPEN_VCR00

public static final int SW_OPEN_VCR00

Constants.

See Also:

Constant Field Values

SW_OPEN_VCR01

public static final int SW_OPEN_VCR01

Constants.

See Also:

Constant Field Values

SW_OPEN_VCR02

public static final int SW_OPEN_VCR02

Constants.

See Also:

Constant Field Values

SW_OPEN_VCR03

public static final int SW_OPEN_VCR03

Constants.

See Also:

Constant Field Values

SW_OPEN_VCR04

public static final int SW_OPEN_VCR04

Constants.

See Also:

Constant Field Values

SW_BLOCK_HVPUMP

public static final int SW_BLOCK_HVPUMP

Constants.

See Also:

Constant Field Values

SW_BLOCK_CVPUMP

public static final int SW_BLOCK_CVPUMP

Constants.

See Also:

Constant Field Values

NUM_SWITCHES

public static final int NUM_SWITCHES

Constants.

See Also:

Constant Field Values

Constructor Detail

VacPlutoDevice

public VacPlutoDevice()

Method Detail

initDevice

protected void initDevice()

Performs basic initialization.

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 channel's parameters for validity. The type argument specifies what kind of quantity is being read, and is of the form type:id where type is ADDBIT, ADDREG or GLOBAL and id is an integer identifying the instance of the type The subType argument is not used. The allowed values of hwChan depend on the type: ADDBIT: 0-15, ADDREG: 0-1, GLOBAL: 0-31

Overrides:

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

Parameters:

name - The channel name

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] values.

Throws:

Exception - if any errors found in the parameters.

readChannelGroup

protected void readChannelGroup()

Reads all referenced channels.

Overrides:

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

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

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

Parameters:

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

Returns:

The read value

setSwitchOn

public void setSwitchOn(int sw,
                        boolean on)

Sets a switch on or off. For the vacuum Pluto, this is implemented as a pair of push buttons, one for on, one for off.

Parameters:

sw - The switch number.

on - The on state to set: true or false

isSwitchOn

public Boolean isSwitchOn(int sw)

Gets the on state of a switch. The state is not the state of the bit that was toggled, but is read back either directly from the controlled hardware, or from the PLC output line.

Parameters:

sw - The switch number.

Returns:

Whether the switch is on

getConditionIds

public List<Integer> getConditionIds()

Gets the list of conditions in use.

Returns:

The condition identifiers

isConditionActive

public Boolean isConditionActive(int cond)

Gets whether a condition is active.

Parameters:

cond - The condition number

Returns:

Whether active - indicated by the bit being 0

isConditionLatched

public Boolean isConditionLatched(int cond)

Gets whether a condition is latched.

Parameters:

cond - The condition number

Returns:

Whether latched - indicated by the bit being 1

clearCondition

public void clearCondition(int cond)

Clears a condition.

Parameters:

cond - The condition number