org.lsst.ccs.subsystem.rafts

Class SequencerProc

java.lang.Object

org.lsst.ccs.subsystem.rafts.SequencerProc

public class SequencerProc
extends Object

Routines for accessing a REB sequencer.

Author:

Owen Saxton

Constructor Summary

Constructors

Constructor and Description
SequencerProc(org.lsst.ccs.drivers.reb.BaseSet bss) Constructor.

Method Summary

Modifier and Type	Method and Description
void	enableScan(boolean value) Enables or disables scan mode.
int	getDataSource() Gets the data source.
int	getErrorAddr() Gets error address.
Map<String,Integer>	getFunctionMap() Gets the map of functions.
int[]	getImageRegisters() Gets the array of image parameter registers to be read
int[]	getImageRegisters(String[] names, boolean strict) Gets the array of image parameter register addresses to be read
Map<String,Integer>	getMainMap() Gets the map of main programs.
List<String>	getMains() Gets the list of main programs.
int	getParameter(String parmName) Gets a parameter value.
Map<String,FPGA2Model.PointerInfo>	getPointers() Gets the map of pointer information.
Map<String,Integer>	getSubroutineMap() Gets the map of subroutines.
boolean	isRunning() Checks whether the sequencer is running.
boolean	isScanEnabled() Gets the scan mode enabled state.
int	loadSequencer(FPGA2Model model) Load the sequencer from a compiled FPGA model.
int	loadSequencer(InputStream in) Loads a sequencer from an input string.
int	loadSequencer(String fileName) Loads the sequencer from a file.
void	resetError() Resets error state.
void	resetScan() Resets scan mode.
void	sendStep() Sends a sequencer step command.
void	sendStop() Sends a sequencer stop command.
void	setCcdMask(int ccdMask) Sets the mask of CCDs being used.
void	setDataSource(int value) Sets the data source.
void	setParameter(String parmName, int value) Sets a parameter value.
int	setStart(int address) Sets the sequencer start address.
int	setStart(String mainName) Sets the sequencer start address.
void	startSequencer() Starts the sequencer.
void	waitDone(int timeout) Waits for the sequencer to be done (idle)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SequencerProc

public SequencerProc(org.lsst.ccs.drivers.reb.BaseSet bss)

Constructor.

Parameters:

bss -

Method Detail

loadSequencer

public int loadSequencer(String fileName)
                  throws org.lsst.ccs.drivers.reb.REBException,
                         IOException

Loads the sequencer from a file. The file format may be XML, LPNHE assembler (.seq)

Parameters:

fileName - The name of the file containing sequencer instructions

Returns:

The number of slices generated by the default main

Throws:

IOException - If there is an error opening or reading the file

org.lsst.ccs.drivers.reb.REBException - If there is an error communicating with the REB

loadSequencer

public int loadSequencer(InputStream in)
                  throws IOException,
                         org.lsst.ccs.drivers.reb.REBException

Loads a sequencer from an input string. This routine supports loading XML or assembler (.seq) format.

Parameters:

in - The input stream to read

Returns:

The number of slices generated by the default main

Throws:

IOException - If there is an error opening or reading the file

org.lsst.ccs.drivers.reb.REBException - If there is an error communicating with the REB

loadSequencer

public int loadSequencer(FPGA2Model model)
                  throws org.lsst.ccs.drivers.reb.REBException

Load the sequencer from a compiled FPGA model. Note this method computes many quantities, which the other methods in this class rely on.

Parameters:

model - The model to load

Returns:

The number of slices generated by the default main

Throws:

org.lsst.ccs.drivers.reb.REBException - If there is an error talking to the REB

getMains

public List<String> getMains()

Gets the list of main programs.

Returns:

The list of known names of main programs, or null is there are no such names.

getMainMap

public Map<String,Integer> getMainMap()

Gets the map of main programs.

Returns:

The name-to-address map of main programs

getSubroutineMap

public Map<String,Integer> getSubroutineMap()

Gets the map of subroutines.

Returns:

The name-to-address map of subroutines

getFunctionMap

public Map<String,Integer> getFunctionMap()

Gets the map of functions.

Returns:

The name-to-number map of functions

getPointers

public Map<String,FPGA2Model.PointerInfo> getPointers()

Gets the map of pointer information.

Returns:

The name-to-type-and-address map of pointers

getImageRegisters

public int[] getImageRegisters()

Gets the array of image parameter registers to be read

Returns:

The array of register addresses

getImageRegisters

public int[] getImageRegisters(String[] names,
                               boolean strict)
                        throws RaftException

Gets the array of image parameter register addresses to be read

Parameters:

names - The list of parameter names

strict - if true will throw an exception if any named registers are missing, otherwise just substitute an address guaranteed to point to zero.

Returns:

An array of addresses

Throws:

RaftException - If strict is true, and requested names are missing or invalid.

setStart

public int setStart(String mainName)
             throws org.lsst.ccs.drivers.reb.REBException,
                    RaftException

Sets the sequencer start address.

Parameters:

mainName - The name of the main to start at

Returns:

The number of slices produced by this main

Throws:

org.lsst.ccs.drivers.reb.REBException

RaftException

setStart

public int setStart(int address)
             throws org.lsst.ccs.drivers.reb.REBException

Sets the sequencer start address.

Parameters:

address - The address of the main to start at

Returns:

The number of slices produced by this main

Throws:

org.lsst.ccs.drivers.reb.REBException

setParameter

public void setParameter(String parmName,
                         int value)
                  throws org.lsst.ccs.drivers.reb.REBException,
                         RaftException

Sets a parameter value.

Parameters:

parmName - The name of the parameter to set

value - The value to set

Throws:

org.lsst.ccs.drivers.reb.REBException

RaftException

getParameter

public int getParameter(String parmName)
                 throws org.lsst.ccs.drivers.reb.REBException,
                        RaftException

Gets a parameter value.

Parameters:

parmName - The name of the parameter to set

Returns:

The value

Throws:

org.lsst.ccs.drivers.reb.REBException

RaftException

setCcdMask

public void setCcdMask(int ccdMask)
                throws org.lsst.ccs.drivers.reb.REBException

Sets the mask of CCDs being used.

Parameters:

ccdMask - The mask of active CCDs

Throws:

org.lsst.ccs.drivers.reb.REBException

getDataSource

public int getDataSource()
                  throws org.lsst.ccs.drivers.reb.REBException

Gets the data source.

Returns:

The encoded data source: CCD or pattern

Throws:

org.lsst.ccs.drivers.reb.REBException

setDataSource

public void setDataSource(int value)
                   throws org.lsst.ccs.drivers.reb.REBException

Sets the data source.

Parameters:

value - The encoded data source: CCD or pattern

Throws:

org.lsst.ccs.drivers.reb.REBException

isScanEnabled

public boolean isScanEnabled()
                      throws org.lsst.ccs.drivers.reb.REBException

Gets the scan mode enabled state.

Returns:

Whether scan mode is enabled

Throws:

org.lsst.ccs.drivers.reb.REBException

enableScan

public void enableScan(boolean value)
                throws org.lsst.ccs.drivers.reb.REBException

Enables or disables scan mode.

Parameters:

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

Throws:

org.lsst.ccs.drivers.reb.REBException

resetScan

public void resetScan()
               throws org.lsst.ccs.drivers.reb.REBException

Resets scan mode.

Throws:

org.lsst.ccs.drivers.reb.REBException

getErrorAddr

public int getErrorAddr()
                 throws org.lsst.ccs.drivers.reb.REBException

Gets error address.

Returns:

The sequencer error address

Throws:

org.lsst.ccs.drivers.reb.REBException

resetError

public void resetError()
                throws org.lsst.ccs.drivers.reb.REBException

Resets error state.

Throws:

org.lsst.ccs.drivers.reb.REBException

startSequencer

public void startSequencer()
                    throws org.lsst.ccs.drivers.reb.REBException

Starts the sequencer.

Throws:

org.lsst.ccs.drivers.reb.REBException

sendStop

public void sendStop()
              throws org.lsst.ccs.drivers.reb.REBException

Sends a sequencer stop command.

Throws:

org.lsst.ccs.drivers.reb.REBException

sendStep

public void sendStep()
              throws org.lsst.ccs.drivers.reb.REBException

Sends a sequencer step command.

Throws:

org.lsst.ccs.drivers.reb.REBException

isRunning

public boolean isRunning()
                  throws org.lsst.ccs.drivers.reb.REBException

Checks whether the sequencer is running.

Returns:

Whether the sequencer is running

Throws:

org.lsst.ccs.drivers.reb.REBException

waitDone

public void waitDone(int timeout)
              throws org.lsst.ccs.drivers.reb.REBException

Waits for the sequencer to be done (idle)

Parameters:

timeout - The maximum time to wait (ms)

Throws:

org.lsst.ccs.drivers.reb.REBException