org.lsst.ccs.subsystem.vacuum

Class VacSimPlutoDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

org.lsst.ccs.subsystem.vacuum.VacPlutoDevice

org.lsst.ccs.subsystem.vacuum.VacSimPlutoDevice

All Implemented Interfaces:

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

public class VacSimPlutoDevice
extends VacPlutoDevice

Handles the vacuum system simulated Pluto PLC gateway.

Author:

Owen Saxton

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.vacuum.VacPlutoDevice

condsUsed, latchesUsed, NUM_SWITCHES, SW_BLOCK_CVPUMP, SW_BLOCK_CVSTAT, SW_BLOCK_HVPUMP, SW_BLOCK_HVSTAT, SW_OPEN_VCR00, SW_OPEN_VCR01, SW_OPEN_VCR02, SW_OPEN_VCR03, SW_OPEN_VCR04, SW_OPEN_VHX00

Fields inherited from class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

areas, node, plu

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

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

Constructor Summary

Constructors

Constructor and Description
VacSimPlutoDevice()

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	clearLatch(int cond) Clears a latched condition.
protected void	close() Closes device connection.
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
Boolean	isConditionActive(int cond) Gets whether a condition is active.
Boolean	isLatchActive(int cond) Gets whether a latched condition is active.
Boolean	isLatchLatched(int cond) Gets whether a latched condition is latched.
Boolean	isPLCActive() Tests whether the PLC is active
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	setCondition(int cond, boolean set)
void	setLatchActive(int cond)
void	setLatchLatched(int cond)
void	setSwitchOn(int sw, boolean on) Sets a switch on or off.

Methods inherited from class org.lsst.ccs.subsystem.vacuum.VacPlutoDevice

getConditionIds, getLatchIds

Methods inherited from class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

checkHwLine, isHwLineSet, readAddBit, readAddInt, readAddWord, readBit, setHwLine, toggleBit, writeBit, writeRegister

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

addLine, checkHardware, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getDeviceMonitorUpdateTasks, getFullName, getGroupForChannel, getMonitorUpdateTasksForChannels, getName, getOutputLines, getPath, init, initChannel, initChannel, initSensors, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelNow, 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

checkStopped

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

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

Constructor Detail

VacSimPlutoDevice

public VacSimPlutoDevice()

Method Detail

initDevice

protected void initDevice()

Performs basic initialization.

Overrides:

initDevice in class VacPlutoDevice

initialize

protected void initialize()

Performs full initialization.

Overrides:

initialize in class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

close

protected void close()

Closes device connection.

Overrides:

close in class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

checkChannel

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

Checks a channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

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.

readChannelGroup

protected void readChannelGroup()

Reads all referenced channels.

Overrides:

readChannelGroup in class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

Parameters:

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

Returns:

The read value

isPLCActive

public Boolean isPLCActive()

Tests whether the PLC is active

Overrides:

isPLCActive in class org.lsst.ccs.subsystem.common.devices.pluto.PlutoDevice

Returns:

Whether the PLC is active, or null if offline

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.

Overrides:

setSwitchOn in class VacPlutoDevice

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.

Overrides:

isSwitchOn in class VacPlutoDevice

Parameters:

sw - The switch number.

Returns:

Whether the switch is on

isLatchActive

public Boolean isLatchActive(int cond)

Gets whether a latched condition is active.

Overrides:

isLatchActive in class VacPlutoDevice

Parameters:

cond - The condition number

Returns:

Whether active - indicated by the bit being 0

isLatchLatched

public Boolean isLatchLatched(int cond)

Gets whether a latched condition is latched.

Overrides:

isLatchLatched in class VacPlutoDevice

Parameters:

cond - The condition number

Returns:

Whether latched - indicated by the bit being 1

clearLatch

public void clearLatch(int cond)

Clears a latched condition.

Overrides:

clearLatch in class VacPlutoDevice

Parameters:

cond - The condition number

isConditionActive

public Boolean isConditionActive(int cond)

Gets whether a condition is active.

Overrides:

isConditionActive in class VacPlutoDevice

Parameters:

cond - The condition number

Returns:

Whether active - indicated by the bit being 1

setLatchActive

@Command(type=ACTION)
public void setLatchActive(@Argument(description="Latched condition number")
                                                 int cond)

setLatchLatched

@Command(type=ACTION)
public void setLatchLatched(@Argument(description="Latched condition number")
                                                  int cond)

setCondition

@Command(type=ACTION)
public void setCondition(@Argument(description="Running condition number")
                                               int cond,
                                               @Argument(description="Condition on state")
                                               boolean set)