org.lsst.ccs.subsystem.vacuum

Class IonPumpDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.vacuum.IonPumpDevice

All Implemented Interfaces:

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

public class IonPumpDevice
extends org.lsst.ccs.monitor.Device
implements SwitchDevice

Interface to a SLAC ion pump controller.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHAN_CIP1 Constants.
static int	CHAN_CIP2 Constants.
static int	CHAN_CIP3 Constants.
static int	CHAN_CIP4 Constants.
static int	CHAN_CIP5 Constants.
static int	CHAN_CIP6 Constants.
static int	CHAN_HIP1 Constants.
static int	CHAN_HIP2 Constants.
static int	CHAN_OIP Constants.

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
IonPumpDevice() 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.
List<String>	getChannelNames() Gets the list of defined channel names.
List<Integer>	getChannelNumbers() Gets the list of defined channel numbers.
int	getSwitchDevice() Gets the switch device ID.
Set<String>	getUsageChannelNames() Command to get the set of usage monitoring channel names.
protected void	initDevice() Performs configuration.
protected void	initialize() Performs full initialization.
protected Boolean	isChannelOn(int chan) Gets the on state of a channel.
Boolean	isSwitchOn(int sw) Gets whether a switch is on.
void	postStart() Post start phase
protected double	readChannel(int hwChan, int type) Reads a monitoring channel.
protected void	setChannelOn(int chan, boolean on) Turns a channel on or off
void	setSwitch(int sw, boolean on) Turns a switch on or off.
void	setUsageValue(String chanName, double usage) Command to set the value for a usage monitoring channel.

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

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

checkStopped

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

build, postBuild, postInit, postShutdown, shutdown, start

Field Detail

CHAN_HIP1

public static final int CHAN_HIP1

Constants.

See Also:

Constant Field Values

CHAN_HIP2

public static final int CHAN_HIP2

Constants.

See Also:

Constant Field Values

CHAN_OIP

public static final int CHAN_OIP

Constants.

See Also:

Constant Field Values

CHAN_CIP1

public static final int CHAN_CIP1

Constants.

See Also:

Constant Field Values

CHAN_CIP2

public static final int CHAN_CIP2

Constants.

See Also:

Constant Field Values

CHAN_CIP3

public static final int CHAN_CIP3

Constants.

See Also:

Constant Field Values

CHAN_CIP4

public static final int CHAN_CIP4

Constants.

See Also:

Constant Field Values

CHAN_CIP5

public static final int CHAN_CIP5

Constants.

See Also:

Constant Field Values

CHAN_CIP6

public static final int CHAN_CIP6

Constants.

See Also:

Constant Field Values

Constructor Detail

IonPumpDevice

public IonPumpDevice()

Constructor.

Method Detail

postStart

public void postStart()

Post start phase

Specified by:

postStart in interface org.lsst.ccs.framework.HasLifecycle

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

getUsageChannelNames

@Command(type=QUERY,
         level=0,
         description="Get the set of usage channel names")
public Set<String> getUsageChannelNames()

Command to get the set of usage monitoring channel names.

Returns:

The set of names

setUsageValue

@Command(description="Set the value for a usage monitoring channel",
         level=50)
public void setUsageValue(@Argument(description="Channel name")
                                                                                                                  String chanName,
                                                                                                                  @Argument(description="Usage value")
                                                                                                                  double usage)
                                                                                                           throws VacuumException

Command to set the value for a usage monitoring channel.

Parameters:

chanName - The channel name

usage - The usage value

Throws:

VacuumException

setChannelOn

protected void setChannelOn(int chan,
                            boolean on)

Turns a channel on or off

Parameters:

chan - The hardware channel number

on - Whether to set on or off

isChannelOn

protected Boolean isChannelOn(int chan)

Gets the on state of a channel.

Parameters:

chan - The hardware channel number

Returns:

Whether the line is on or off

getChannelNames

public List<String> getChannelNames()

Gets the list of defined channel names.

Returns:

The channel names

getChannelNumbers

public List<Integer> getChannelNumbers()

Gets the list of defined channel numbers.

Returns:

The channel numbers

getSwitchDevice

public int getSwitchDevice()

Gets the switch device ID.

Specified by:

getSwitchDevice in interface SwitchDevice

Returns:

The device ID

setSwitch

public void setSwitch(int sw,
                      boolean on)

Turns a switch on or off.

Specified by:

setSwitch in interface SwitchDevice

Parameters:

sw - The switch ID

on - Whether to turn on or off

isSwitchOn

public Boolean isSwitchOn(int sw)

Gets whether a switch is on.

Specified by:

isSwitchOn in interface SwitchDevice

Parameters:

sw - The switch ID

Returns:

Whether on, or null if device is offline