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

Class PlutoDevice

java.lang.Object

org.lsst.ccs.monitor.Device

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

All Implemented Interfaces:

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

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

Handles a Pluto PLC system.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Integer>	areas
protected String	node Data fields.
protected org.lsst.ccs.drivers.pluto.Pluto	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
PlutoDevice() Constructor.
PlutoDevice(int nArea) 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	checkHwLine(String name, int line) Checks an output line number.
protected void	close() Closes the connection.
protected void	initDevice() Performs configuration.
protected void	initialize() Performs full initialization.
protected Boolean	isHwLineSet(int line) Gets the set state of an output line.
Boolean	isPLCActive() Gets whether the PLC is active.
Integer	readAddBit(int area, int bit) Reads a bit value from an additional area.
Integer	readAddInt(int area) Reads the value from an additional area.
Integer	readAddWord(int area, int word) Reads a signed word (16-bit) value from an additional area.
Integer	readBit(int area, int bit) Reads a bit value.
protected double	readChannel(int hwChan, int type) Reads a channel.
protected void	readChannelGroup() Reads all referenced channels.
protected void	setHwLine(int line, boolean on) Sets an output line on or off.
void	toggleBit(int area, int bit) Toggles a bit.
void	writeBit(int area, int bit, int value) Writes a bit value.
void	writeRegister(int area, int reg, int value) Writes a register value.

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

addLine, checkHardware, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getFullName, getGroupForChannel, 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

Field Detail

node

@ConfigurationParameter(category="Device",
                        isFinal=true)
protected String node

Data fields.

areas

protected List<Integer> areas

plu

protected org.lsst.ccs.drivers.pluto.Pluto plu

Constructor Detail

PlutoDevice

public PlutoDevice()

Constructor.

PlutoDevice

public PlutoDevice(int nArea)

Constructor.

Parameters:

nArea - The number of additional areas to use, or -1 if the areas need to be configured

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 channel's parameters for validity.

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

checkHwLine

protected void checkHwLine(String name,
                           int line)
                    throws Exception

Checks an output line number.

Overrides:

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

Parameters:

name - The name of the output line.

line - The hardware line number of the output line.

Throws:

Exception - If line number is invalid

setHwLine

protected void setHwLine(int line,
                         boolean on)

Sets an output line on or off.

Overrides:

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

Parameters:

line - The output line number.

on - The on state to set: true or false

isHwLineSet

protected Boolean isHwLineSet(int line)

Gets the set state of an output line.

Overrides:

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

Parameters:

line - The output line number.

Returns:

Whether the line is on

isPLCActive

public Boolean isPLCActive()

Gets whether the PLC is active.

Returns:

Whether active, or null if offline (or other read error).

toggleBit

public void toggleBit(int area,
                      int bit)

Toggles a bit.

Parameters:

area - The area number

bit - The bit number

writeBit

public void writeBit(int area,
                     int bit,
                     int value)

Writes a bit value.

Parameters:

area - The area number

bit - The bit number

value - The bit value

readBit

public Integer readBit(int area,
                       int bit)

Reads a bit value.

Parameters:

area - The area number

bit - The bit number

Returns:

The bit value, or null if device is offline

readAddBit

public Integer readAddBit(int area,
                          int bit)

Reads a bit value from an additional area.

Parameters:

area - The area number

bit - The bit number (0 - 31)

Returns:

The bit value, or null if device offline

readAddWord

public Integer readAddWord(int area,
                           int word)

Reads a signed word (16-bit) value from an additional area.

Parameters:

area - The area number

word - The word number (0 - 1)

Returns:

The bit value, or null if device offline

readAddInt

public Integer readAddInt(int area)

Reads the value from an additional area.

Parameters:

area - The area number

Returns:

The integer value, or null if device offline

writeRegister

public void writeRegister(int area,
                          int reg,
                          int value)

Writes a register value.

Parameters:

area - The area number

reg - The register number

value - The register value