org.lsst.ccs.subsystem.refrig

Class SimCompPlutoDevice

java.lang.Object

org.lsst.ccs.monitor.Device

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

org.lsst.ccs.subsystem.refrig.CompPlutoDevice

org.lsst.ccs.subsystem.refrig.SimCompPlutoDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle, Compressor.SwitchDevice

public class SimCompPlutoDevice
extends CompPlutoDevice

Simulates the compressor Pluto PLC.

Author:

Owen Saxton

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.refrig.CompPlutoDevice

NUM_COLD_SWITCHES, NUM_CRYO_SWITCHES, SW_ENABLE, SW_HEATER, SW_LIGHTS

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

areas, node, plu

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
SimCompPlutoDevice() Constructor.

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.
protected void	close() Closes device connection.
String	getChannelNames()
String	getConditionNames()
ConditionState	getConditionState(int cond) Gets the state of a condition.
int	getErrorCode() Gets the PLC error code.
String	getLatchNames()
LatchState	getLatchState(int cond) Gets the state of a latched condition.
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
Boolean	isPLCActive() Checks whether 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	resetLatches() Resets all latches.
void	setChannelValue(String chan, double value)
void	setCondition(String cond, boolean set)
void	setLatchActive(String cond)
void	setLatchLatched(String cond)
void	setLatchWarning(String cond)
void	setPLCActive(boolean set)
void	setSwitchOn(int sw, boolean on) Sets a switch on or off.
void	setType(int type) Sets the compressor type.

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

Constructor Detail

SimCompPlutoDevice

public SimCompPlutoDevice()

Constructor.

Method Detail

initDevice

protected void initDevice()

Performs basic initialization.

Overrides:

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

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)
                      throws Exception

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.

Throws:

Exception - if there is a parameter error

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

setType

public void setType(int type)

Sets the compressor type.

Overrides:

setType in class CompPlutoDevice

Parameters:

type - The type (cold or cryo)

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.

Specified by:

setSwitchOn in interface Compressor.SwitchDevice

Overrides:

setSwitchOn in class CompPlutoDevice

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.

Specified by:

isSwitchOn in interface Compressor.SwitchDevice

Overrides:

isSwitchOn in class CompPlutoDevice

Parameters:

sw - The switch number.

Returns:

Whether the switch is on

getLatchState

public LatchState getLatchState(int cond)

Gets the state of a latched condition.

Overrides:

getLatchState in class CompPlutoDevice

Parameters:

cond - The condition number

Returns:

The condition state

getConditionState

public ConditionState getConditionState(int cond)

Gets the state of a condition.

Overrides:

getConditionState in class CompPlutoDevice

Parameters:

cond - The condition number

Returns:

The condition state

resetLatches

public void resetLatches()

Resets all latches.

Overrides:

resetLatches in class CompPlutoDevice

isPLCActive

public Boolean isPLCActive()

Checks whether PLC is active

Overrides:

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

Returns:

Whether active

getErrorCode

public int getErrorCode()

Gets the PLC error code.

Overrides:

getErrorCode in class CompPlutoDevice

Returns:

The error code

getLatchNames

@Command(type=QUERY,
         description="Get the list of latched condition names")
public String getLatchNames()

setLatchActive

@Command(type=ACTION,
         description="Make a latched condition active")
public void setLatchActive(@Argument(description="Latched condition name")
                                                                                                         String cond)
                                                                                                  throws RefrigException

Throws:

RefrigException

setLatchLatched

@Command(type=ACTION,
         description="Make a latched condition latched")
public void setLatchLatched(@Argument(description="Latched condition name")
                                                                                                           String cond)
                                                                                                    throws RefrigException

Throws:

RefrigException

setLatchWarning

@Command(type=ACTION,
         description="Put a latched condition into warning state")
public void setLatchWarning(@Argument(description="Latched condition name")
                                                                                                                     String cond)
                                                                                                              throws RefrigException

Throws:

RefrigException

getConditionNames

@Command(type=QUERY,
         description="Get the list of condition names")
public String getConditionNames()

setCondition

@Command(type=ACTION,
         description="Set the state of a condition")
public void setCondition(@Argument(description="Running condition name")
                                                                                                    String cond,
                                                                                                    @Argument(description="Condition on state")
                                                                                                    boolean set)
                                                                                             throws RefrigException

Throws:

RefrigException

setChannelValue

@Command(type=ACTION,
         description="Set a channel value")
public void setChannelValue(@Argument(description="Channel name")
                                                                                              String chan,
                                                                                              @Argument(description="Channel value")
                                                                                              double value)
                                                                                       throws RefrigException

Throws:

RefrigException

getChannelNames

@Command(type=QUERY,
         description="Get the list of channel names")
public String getChannelNames()

setPLCActive

@Command(type=ACTION,
         description="Set whether PLC is active")
public void setPLCActive(@Argument(description="PLC active state")
                                                                                                 boolean set)