org.lsst.ccs.subsystem.common.devices.dataforth

Class Maq20Device

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.common.devices.dataforth.Maq20Device

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle

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

Handles a Dataforth Maq20 DAQ system.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	Maq20Device.Maq20Control Inner control interface.
static class	Maq20Device.ModuleData Inner class for holding dynamic module data.
static class	Maq20Device.ModuleDef Inner class for holding static module type constants.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHAN_FREQUENCY
static int	CHAN_PULSE_COUNT
static int	CHAN_PULSE_RPM
static int	CHAN_PWM_LOW1
static int	CHAN_PWM_LOW2
static int	CHAN_PWM_PERIOD
protected Map<String,Maq20Device.Maq20Control>	controlMap Data fields.
static int	DISC_FUNC_FREQ
static int	DISC_FUNC_NONE
static int	DISC_FUNC_PULSE
static int	DISC_FUNC_PWM
protected org.lsst.ccs.drivers.dataforth.Maq20	maq
protected String[]	modules
protected String	node
static int	NUM_CHAN_DINP Public constants
static int	NUM_CHAN_DIOH Public constants
static int	NUM_CHAN_DIOL Public constants
static int	NUM_CHAN_DOUT Public constants
static int	NUM_CHAN_FREQ Public constants
static int	NUM_CHAN_IVD Public constants
static int	NUM_CHAN_IVO Public constants
static int	NUM_CHAN_IVS Public constants
static int	NUM_CHAN_PULSE Public constants
static int	NUM_CHAN_PWM Public constants
static int	NUM_CHAN_RTD Public constants
static int	NUM_CHAN_TC Public constants
protected String[]	serials

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
Maq20Device()

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(String chName, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
protected void	furtherInitialization() Method to perform further initialization.
int	getModuleCount() Gets the number of defined modules.
Maq20Device.ModuleData	getModuleData(int index) Gets the module data with the specified index.
protected void	initChannel(String chName, int id, int hwChan, int type, int subtype) Initializes a channel.
protected void	initDevice() Performs configuration.
protected void	initialize() Performs full initialization.
protected double	readChannel(int hwChan, int type) Reads a channel.
void	setOnline(boolean state) Sets the device online state (public version)

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

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

Field Detail

NUM_CHAN_TC

public static final int NUM_CHAN_TC

Public constants

See Also:

Constant Field Values

NUM_CHAN_RTD

public static final int NUM_CHAN_RTD

Public constants

See Also:

Constant Field Values

NUM_CHAN_IVS

public static final int NUM_CHAN_IVS

Public constants

See Also:

Constant Field Values

NUM_CHAN_IVD

public static final int NUM_CHAN_IVD

Public constants

See Also:

Constant Field Values

NUM_CHAN_IVO

public static final int NUM_CHAN_IVO

Public constants

See Also:

Constant Field Values

NUM_CHAN_DIOL

public static final int NUM_CHAN_DIOL

Public constants

See Also:

Constant Field Values

NUM_CHAN_DIOH

public static final int NUM_CHAN_DIOH

Public constants

See Also:

Constant Field Values

NUM_CHAN_PULSE

public static final int NUM_CHAN_PULSE

Public constants

See Also:

Constant Field Values

NUM_CHAN_PWM

public static final int NUM_CHAN_PWM

Public constants

See Also:

Constant Field Values

NUM_CHAN_FREQ

public static final int NUM_CHAN_FREQ

Public constants

See Also:

Constant Field Values

NUM_CHAN_DINP

public static final int NUM_CHAN_DINP

Public constants

See Also:

Constant Field Values

NUM_CHAN_DOUT

public static final int NUM_CHAN_DOUT

Public constants

See Also:

Constant Field Values

CHAN_FREQUENCY

public static final int CHAN_FREQUENCY

See Also:

Constant Field Values

CHAN_PULSE_COUNT

public static final int CHAN_PULSE_COUNT

See Also:

Constant Field Values

CHAN_PULSE_RPM

public static final int CHAN_PULSE_RPM

See Also:

Constant Field Values

CHAN_PWM_PERIOD

public static final int CHAN_PWM_PERIOD

See Also:

Constant Field Values

CHAN_PWM_LOW1

public static final int CHAN_PWM_LOW1

See Also:

Constant Field Values

CHAN_PWM_LOW2

public static final int CHAN_PWM_LOW2

See Also:

Constant Field Values

DISC_FUNC_NONE

public static final int DISC_FUNC_NONE

See Also:

Constant Field Values

DISC_FUNC_PULSE

public static final int DISC_FUNC_PULSE

See Also:

Constant Field Values

DISC_FUNC_PWM

public static final int DISC_FUNC_PWM

See Also:

Constant Field Values

DISC_FUNC_FREQ

public static final int DISC_FUNC_FREQ

See Also:

Constant Field Values

controlMap

@LookupField(strategy=CHILDREN)
protected final Map<String,Maq20Device.Maq20Control> controlMap

Data fields.

node

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

serials

@ConfigurationParameter(category="Device",
                        maxLength=24,
                        isFinal=true)
protected volatile String[] serials

modules

protected String[] modules

maq

protected final org.lsst.ccs.drivers.dataforth.Maq20 maq

Constructor Detail

Maq20Device

public Maq20Device()

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

furtherInitialization

protected void furtherInitialization()
                              throws org.lsst.ccs.drivers.commons.DriverException

Method to perform further initialization. This method is to be implemented by subclasses. If anything goes wrong with the initialization it should throw a DriverException.

Throws:

org.lsst.ccs.drivers.commons.DriverException - Thrown if anything goes wrong with the initialization.

close

protected void close()

Closes the connection.

Specified by:

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

setOnline

public void setOnline(boolean state)

Sets the device online state (public version)

Overrides:

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

Parameters:

state -

checkChannel

protected int[] checkChannel(String chName,
                             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:

chName - The name of the channel.

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.

initChannel

protected void initChannel(String chName,
                           int id,
                           int hwChan,
                           int type,
                           int subtype)

Initializes a channel. Much of the testing that is often done in checkChannel() has to be done here because the device has to be opened first.

Overrides:

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

Parameters:

chName - The channel name

id - The channel ID

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

subtype - The channel subtype returned by checkChannel.

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:

Channel value

getModuleCount

public int getModuleCount()

Gets the number of defined modules.

Returns:

The number of modules

getModuleData

public Maq20Device.ModuleData getModuleData(int index)

Gets the module data with the specified index.

Parameters:

index - The module index

Returns:

The module data, or null if index is invalid