org.lsst.ccs.subsystem.rafts

Class REBSimDevice

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Device

org.lsst.ccs.subsystem.rafts.REBDevice

org.lsst.ccs.subsystem.rafts.REBSimDevice

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable

public class REBSimDevice
extends REBDevice

Implements access to a simulated REB device.

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.rafts.REBDevice

CCD_MASK, ccdMask, currImage, id, ID, IFC_NAME, ifcName, imageTime, maxCcdMask, numCcds

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

chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, online

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

environment

Constructor Summary

Constructors

Constructor and Description
REBSimDevice(int id, String ifcName, int ccdMask) Constructor.

Method Summary

Modifier and Type	Method and Description
int	checkAspics() Checks loaded ASPIC configuration data.
List<Integer>	checkCabacs() Checks loaded CABAC configuration data.
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
void	enableScan(boolean value) Enables or disables scan mode.
int	getCabacPower() Gets the CABAC power enable bits.
int	getDataSource() Gets the data source.
REB	getREBConfig() Gets the REB configuration data.
StatusData	getRebStatus() Gets the REB status block.
RegisterData	getRegister(int address, int count) Gets the contents of REB registers.
long	getTime() Gets the time base as Unix time.
long	getTime(String rSet) Gets a trigger time as Unix time.
protected void	initialize() Performs basic initialization.
boolean	isScanEnabled() Gets the scan mode enabled state.
int	loadAspics() Loads configuration data to the ASPICs.
int	loadCabacs() Loads configuration data to the CABACs in a safe way.
int	loadDacs() Loads configured DAC values.
int	loadSequencer(List<int[]> seqInst) Loads the sequencer from an object.
int	loadSequencerFile(String fileName) Loads the sequencer from a file.
protected double	readChannel(int hwChan, int type) Reads a channel.
protected void	readChannelGroup() Reads grouped channels.
void	resetFrontEnd() Resets the front end.
void	resetScan() Resets scan mode.
void	sendStep() Sends a sequencer step command.
void	sendStop() Sends a sequencer stop command.
void	setCabacPower(int enables) Sets the CABAC power enable bits.
void	setDataSource(int value) Sets the data source.
void	setREBConfig(REB reb) Sets the REB configuration data.
void	setRegister(int address, int[] values) Sets the contents of REB registers.
void	setTime() Sets the time base to the current system time.
void	startSequencer() Starts the sequencer.

Methods inherited from class org.lsst.ccs.subsystem.rafts.REBDevice

addConfigValues, configure, getCcdMask, getId, getIfcName, getImage, getImageMetadata, saveFitsImage, saveImage, setCcdMask, setConstFitsMetadata, setFitsConditions, setFitsParameters, setId, setIfcName, splitImage

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

addChannel, addLine, checkHwLine, checkLine, checkOnline, checkTimeout, disable, dropChannel, enable, getConfigValues, getFullName, getOutputLines, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent

getChildren, getEnvironment, setEnvironment

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.Configurable

alias, change, getCheckedValueFromConfiguration, getComponentByName, getDictionary, getName, getParent, getParentObject, getSubsystem, init, injectResources, listChildren, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, proceduralWalk, publish, publish, publish, publish, publish, publish, shutdownNow, start, treeWalk

Constructor Detail

REBSimDevice

public REBSimDevice(int id,
                    String ifcName,
                    int ccdMask)

Constructor.

Parameters:

id - The REB ID

ifcName - The name of the network interface to use

ccdMask - The mask of active CCDs

Method Detail

initialize

protected void initialize()

Performs basic initialization.

Overrides:

initialize in class REBDevice

close

protected void close()

Closes the connection.

Overrides:

close in class REBDevice

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 REBDevice

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

readChannelGroup

protected void readChannelGroup()

Reads grouped channels.

Overrides:

readChannelGroup in class REBDevice

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

readChannel in class REBDevice

Parameters:

hwChan - The hardware channel number

type - The encoded channel type

Returns:

The read value

setREBConfig

@Command(type=ACTION,
         description="Sets the REB configuration data")
public void setREBConfig(@Argument(name="reb",description="REB configuration data")
                                                                                                       REB reb)
                                                                                                throws Exception

Sets the REB configuration data.

Overrides:

setREBConfig in class REBDevice

Parameters:

reb - The REB configuration (object)

Throws:

Exception

getREBConfig

@Command(type=QUERY,
         description="Gets the REB configuration data")
public REB getREBConfig()
                                                                                              throws RaftException

Gets the REB configuration data.

Overrides:

getREBConfig in class REBDevice

Returns:

The REB configuration (object)

Throws:

RaftException

loadDacs

@Command(type=ACTION,
         description="Loads configured DAC values")
public int loadDacs()
                                                                                       throws Exception

Loads configured DAC values.

Overrides:

loadDacs in class REBDevice

Returns:

The number of DACs loaded

Throws:

Exception

loadCabacs

@Command(type=ACTION,
         description=" Loads configuration data to the CABACs")
public int loadCabacs()
                                                                                                     throws Exception

Loads configuration data to the CABACs in a safe way.

Overrides:

loadCabacs in class REBDevice

Returns:

The number of CABACs loaded

Throws:

Exception

checkCabacs

@Command(type=QUERY,
         description="Checks loaded CABAC configuration data")
public List<Integer> checkCabacs()
                                                                                                              throws Exception

Checks loaded CABAC configuration data.

Overrides:

checkCabacs in class REBDevice

Returns:

A list containing, for each configured CABAC, a mask showing which fields don't match

Throws:

Exception

setCabacPower

@Command(type=ACTION,
         description="Sets the CABAC power enable bits")
public void setCabacPower(@Argument(description="Enable bits")
                                                                                                         int enables)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Sets the CABAC power enable bits.

Overrides:

setCabacPower in class REBDevice

Parameters:

enables - The enable bits

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCabacPower

@Command(type=QUERY,
         description="Gets the CABAC power enable bits")
public int getCabacPower()

Gets the CABAC power enable bits.

Overrides:

getCabacPower in class REBDevice

Returns:

The enable bits

loadAspics

@Command(type=ACTION,
         description=" Load configuration data to the ASPICs")
public int loadAspics()
                                                                                                    throws Exception

Loads configuration data to the ASPICs.

Overrides:

loadAspics in class REBDevice

Returns:

The number of ASPICs loaded

Throws:

Exception

checkAspics

@Command(type=ACTION,
         description=" Load configuration data to the ASPICs")
public int checkAspics()
                                                                                                     throws Exception

Checks loaded ASPIC configuration data.

Overrides:

checkAspics in class REBDevice

Returns:

The mask of mismatched fields

Throws:

Exception

setTime

@Command(type=ACTION,
         description="Sets the time base to the current system time")
public void setTime()
                                                                                                         throws Exception

Sets the time base to the current system time.

Overrides:

setTime in class REBDevice

Throws:

Exception

getTime

@Command(type=QUERY,
         description="Gets the time base as Unix time")
public long getTime()
                                                                                          throws Exception

Gets the time base as Unix time.

Overrides:

getTime in class REBDevice

Returns:

The time base converted to Unix time

Throws:

Exception

getTime

@Command(type=QUERY,
         description="Gets a trigger time as Unix time")
public long getTime(@Argument(name="regset",description="Register set name")
                                                                                                  String rSet)
                                                                                           throws Exception

Gets a trigger time as Unix time.

Overrides:

getTime in class REBDevice

Parameters:

rSet - The name of the trigger time's register set: "stat", "time" or "seq:.

Returns:

The trigger time converted to Unix time

Throws:

Exception

loadSequencerFile

@Command(type=ACTION,
         description="Loads the sequencer from a file")
public int loadSequencerFile(@Argument(name="filename",description="Sequencer file name")
                                                                                                           String fileName)
                                                                                                    throws Exception,
                                                                                                           IOException

Loads the sequencer from a file.

Overrides:

loadSequencerFile in class REBDevice

Parameters:

fileName - The name of the file containing sequencer instructions

Returns:

The number of slices expected to be read

Throws:

Exception

IOException

loadSequencer

@Command(type=ACTION,
         description="Loads the sequencer from an object")
public int loadSequencer(@Argument(name="seqinst",description="Sequencer instructions")
                                                                                                          List<int[]> seqInst)
                                                                                                   throws Exception

Loads the sequencer from an object.

Overrides:

loadSequencer in class REBDevice

Parameters:

seqInst - The sequencer instructions to be loaded

Returns:

The number of slices expected to be read

Throws:

Exception

getDataSource

@Command(type=QUERY,
         description="Gets the data source")
public int getDataSource()
                                                                                    throws Exception

Gets the data source.

Overrides:

getDataSource in class REBDevice

Returns:

The encoded data source: CCD or pattern

Throws:

Exception

setDataSource

@Command(type=ACTION,
         description="Sets the data source")
public void setDataSource(@Argument(name="value",description="The data source value")
                                                                                             int value)
                                                                                      throws Exception

Sets the data source.

Overrides:

setDataSource in class REBDevice

Parameters:

value - The encoded data source: CCD or pattern

Throws:

Exception

isScanEnabled

@Command(type=QUERY,
         description="Gets the scan mode enabled state")
public boolean isScanEnabled()
                                                                                                    throws Exception

Gets the scan mode enabled state.

Overrides:

isScanEnabled in class REBDevice

Returns:

Whether scan mode is enabled

Throws:

Exception

enableScan

@Command(type=ACTION,
         description="Enable or disable scan mode")
public void enableScan(@Argument(name="value",description="The scan mode enabled state")
                                                                                                 boolean value)
                                                                                          throws Exception

Enables or disables scan mode.

Overrides:

enableScan in class REBDevice

Parameters:

value - The scan mode enabled state to set (true or false)

Throws:

Exception

resetScan

@Command(type=ACTION,
         description="Resets scan mode")
public void resetScan()
                                                                              throws Exception

Resets scan mode.

Overrides:

resetScan in class REBDevice

Throws:

Exception

startSequencer

@Command(type=ACTION,
         description="Starts the sequencer")
public void startSequencer()
                                                                                       throws Exception

Starts the sequencer.

Overrides:

startSequencer in class REBDevice

Throws:

Exception

sendStop

@Command(type=ACTION,
         description="Sends a sequencer stop command")
public void sendStop()
                                                                                           throws Exception

Sends a sequencer stop command.

Overrides:

sendStop in class REBDevice

Throws:

Exception

sendStep

@Command(type=ACTION,
         description="Sends a sequencer step command")
public void sendStep()
                                                                                           throws Exception

Sends a sequencer step command.

Overrides:

sendStep in class REBDevice

Throws:

Exception

resetFrontEnd

@Command(type=ACTION,
         description="Resets the front end")
public void resetFrontEnd()
                                                                                      throws Exception

Resets the front end. This is the only way to stop a running sequencer program

Overrides:

resetFrontEnd in class REBDevice

Throws:

Exception

getRegister

@Command(type=QUERY,
         description="Gets the contents of REB registers")
public RegisterData getRegister(@Argument(name="address",description="Address of the first register")
                                                                                                                int address,
                                                                                                                @Argument(name="count",description="Number of registers to read")
                                                                                                                int count)
                                                                                                         throws Exception

Gets the contents of REB registers.

Overrides:

getRegister in class REBDevice

Parameters:

address - The address of the first register to read

count - The number of registers to read

Returns:

The block of register values

Throws:

Exception

setRegister

@Command(type=ACTION,
         description="Sets the contents of REB registers")
public void setRegister(@Argument(name="address",description="Address of the first register")
                                                                                                         int address,
                                                                                                         @Argument(name="values",description="Values to write")
                                                                                                         int[] values)
                                                                                                  throws Exception

Sets the contents of REB registers.

Overrides:

setRegister in class REBDevice

Parameters:

address - The address of the first register to write

values - The array of values to write to consecutive registers

Throws:

Exception

getRebStatus

@Command(type=QUERY,
         description="Gets the REB status block")
public StatusData getRebStatus()
                                                                                               throws Exception

Gets the REB status block.

Overrides:

getRebStatus in class REBDevice

Returns:

The REB status block

Throws:

Exception