Sequencer (LSST Camera Control Software

java.lang.Object
- org.lsst.ccs.drivers.rcm.RegClient
- - org.lsst.ccs.drivers.rcm.BaseSet
  - - org.lsst.ccs.drivers.rcm.Sequencer

Direct Known Subclasses:

SequencerUtils
```
public class Sequencer
extends BaseSet
```
RCM sequencer access routines.

Author:

Owen Saxton

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[][]`	`lines` Fields.
`protected int[]`	`prog`
`static int`	`REG_SEQ_BEB` Public constants.
`static int`	`REG_SEQ_LINES` Public constants.
`static int`	`REG_SEQ_NSLICE` Public constants.
`static int`	`REG_SEQ_PROGRAM` Public constants.
`static int`	`REG_SEQ_SOURCE` Public constants.
`static int`	`REG_SEQ_SSIZE` Public constants.
`static int`	`REG_SEQ_STACK` Public constants.
`static int`	`REG_SEQ_STEP` Public constants.
`static int`	`REG_SEQ_STEP_0` Public constants.
`static int`	`REG_SEQ_STOP` Public constants.
`static int`	`REG_SEQ_STOP_0` Public constants.
`static int`	`REG_SEQ_TIMES` Public constants.
`static int`	`SEQ_MAX_FUNC` Public constants.
`static int`	`SEQ_MAX_FUNC_0` Public constants.
`static int`	`SEQ_MAX_PROGRAM` Public constants.
`static int`	`SEQ_MAX_SLICE` Public constants.
`static int`	`SEQ_MAX_STACK` Public constants.
`static int`	`SEQ_OPC_END_PROG` Public constants.
`static int`	`SEQ_OPC_END_SUBR` Public constants.
`static int`	`SEQ_OPC_EXECUTE` Public constants.
`static int`	`SEQ_OPC_JUMP` Public constants.
`static int`	`SEQ_PRG_M_EXCCNT` Public constants.
`static int`	`SEQ_PRG_M_FUNC` Public constants.
`static int`	`SEQ_PRG_M_SUBADD` Public constants.
`static int`	`SEQ_PRG_M_SUBCNT` Public constants.
`static int`	`SEQ_PRG_V_FUNC` Public constants.
`static int`	`SEQ_PRG_V_LOOP` Public constants.
`static int`	`SEQ_PRG_V_OPCODE` Public constants.
`static int`	`SEQ_PRG_V_SUBADD` Public constants.
`static int`	`SEQ_SRC_ADC` Public constants.
`static int`	`SEQ_SRC_BEB_ADC` Public constants.
`static int`	`SEQ_SRC_BEB_PTN` Public constants.
`static int`	`SEQ_SRC_FPGA_PTN` Public constants.
`static int`	`SEQ_SRC_PATTERN` Public constants.
`static int`	`SEQ_STK_M_COUNT` Public constants.
`static int`	`SEQ_STK_M_FUNC` Public constants.
`static int`	`SEQ_STK_V_FUNC` Public constants.
`static int`	`SEQ_STK_V_LOOP` Public constants.
`protected int[]`	`stack`
`protected int`	`stackSize`
`protected int[][]`	`times`

Fields inherited from class org.lsst.ccs.drivers.rcm.BaseSet
CLOCK_PERIOD_0, CLOCK_PERIOD_1, REG_ID, REG_SCHEMA, REG_STATE, REG_TIME_BASE, REG_TRIG_TIME, REG_TRIGGER, REG_VERSION, RSET_POWER_ADCS, RSET_SEQUENCER, RSET_STATUS, RSET_TEMP_ADCS, RSET_TIME_BASE, VERSION_0, VERSION_1, VERSION_2, VERSION_UNKNOWN, VERSION_UNSET

Constructor Summary

Constructors
Constructor and Description

Sequencer()

Sequencer(RegClient reg)
Constructors.

Constructors
Constructor and Description
`Sequencer()`
`Sequencer(RegClient reg)` Constructors.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`disable()` Disables the sequencer.
`void`	`enable()` Enables the sequencer.
`long`	`getTriggerTime()` Gets the sequencer trigger time.
`void`	`sendStep()` Sends the step command.
`void`	`sendStop()` Sends the stop command.
`void`	`writeBebSelect(int value)` Writes the BEB selector register.
`void`	`writeDataSource(int value)` Writes the data source register.
`void`	`writeLines(int func, int[] values)` Writes a set of output lines values.
`void`	`writeLines(int func, int[] values, int offset, int count)` Writes a set of output lines values.
`void`	`writeLines(int func, int slice, int value)` Writes an output lines value.
`void`	`writeProgEnd(int addr)` Writes an end program word.
`void`	`writeProgEndSubr(int addr)` Writes an end subroutine word.
`void`	`writeProgExec(int addr, int func, int count)` Writes an execute program word.
`void`	`writeProgJump(int addr, int subaddr, int count)` Writes a jump program word.
`void`	`writeProgram(int addr, int value)` Writes a program word.
`void`	`writeProgram(int addr, int[] values)` Writes a set of program words.
`void`	`writeProgram(int addr, int[] values, int offset, int count)` Writes a set of program words.
`void`	`writeSliceCount(int value)` Writes the slice count.
`void`	`writeStack(int[] values)` Writes a complete set of stack values, setting the stack size.
`void`	`writeStack(int[] values, int offset, int count)` Writes a complete set of stack values, setting the stack size.
`void`	`writeStack(int addr, int value)` Writes a stack value.
`void`	`writeStack(int addr, int[] values)` Writes a set of stack values.
`void`	`writeStack(int addr, int[] values, int offset, int count)` Writes a set of stack values.
`void`	`writeStackSize(int value)` Writes the stack size.
`void`	`writeTimes(int func, int[] values)` Writes a set of time slice values.
`void`	`writeTimes(int func, int[] values, int offset, int count)` Writes a set of time slice values.
`void`	`writeTimes(int func, int slice, int value)` Writes a time slice value.

Methods inherited from class org.lsst.ccs.drivers.rcm.BaseSet
checkNotVersion, checkVersion, disable, enable, getTime, getTimeRaw, getTriggerTime, getTriggerTimeRaw, getVersion, setTime, setTime, setTimeRaw, waitDone

Methods inherited from class org.lsst.ccs.drivers.rcm.RegClient
checkOpen, close, finalize, open, read, read, read, readLong, update, write, write, write, writeLong

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REG_SEQ_LINES
```
public static final int REG_SEQ_LINES
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_TIMES
```
public static final int REG_SEQ_TIMES
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_STACK
```
public static final int REG_SEQ_STACK
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_PROGRAM
```
public static final int REG_SEQ_PROGRAM
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_STEP
```
public static final int REG_SEQ_STEP
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_STOP
```
public static final int REG_SEQ_STOP
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_SSIZE
```
public static final int REG_SEQ_SSIZE
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_NSLICE
```
public static final int REG_SEQ_NSLICE
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_SOURCE
```
public static final int REG_SEQ_SOURCE
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_BEB
```
public static final int REG_SEQ_BEB
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_STEP_0
```
public static final int REG_SEQ_STEP_0
```
    Public constants.
    
    See Also:
    Constant Field Values
  - REG_SEQ_STOP_0
```
public static final int REG_SEQ_STOP_0
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_MAX_FUNC_0
```
public static final int SEQ_MAX_FUNC_0
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_MAX_FUNC
```
public static final int SEQ_MAX_FUNC
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_MAX_SLICE
```
public static final int SEQ_MAX_SLICE
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_MAX_PROGRAM
```
public static final int SEQ_MAX_PROGRAM
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_MAX_STACK
```
public static final int SEQ_MAX_STACK
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_SRC_FPGA_PTN
```
public static final int SEQ_SRC_FPGA_PTN
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_SRC_BEB_PTN
```
public static final int SEQ_SRC_BEB_PTN
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_SRC_BEB_ADC
```
public static final int SEQ_SRC_BEB_ADC
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_SRC_ADC
```
public static final int SEQ_SRC_ADC
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_SRC_PATTERN
```
public static final int SEQ_SRC_PATTERN
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_OPC_EXECUTE
```
public static final int SEQ_OPC_EXECUTE
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_OPC_JUMP
```
public static final int SEQ_OPC_JUMP
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_OPC_END_SUBR
```
public static final int SEQ_OPC_END_SUBR
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_OPC_END_PROG
```
public static final int SEQ_OPC_END_PROG
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_V_OPCODE
```
public static final int SEQ_PRG_V_OPCODE
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_V_FUNC
```
public static final int SEQ_PRG_V_FUNC
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_M_FUNC
```
public static final int SEQ_PRG_M_FUNC
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_V_LOOP
```
public static final int SEQ_PRG_V_LOOP
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_M_EXCCNT
```
public static final int SEQ_PRG_M_EXCCNT
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_V_SUBADD
```
public static final int SEQ_PRG_V_SUBADD
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_M_SUBADD
```
public static final int SEQ_PRG_M_SUBADD
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_PRG_M_SUBCNT
```
public static final int SEQ_PRG_M_SUBCNT
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_STK_V_FUNC
```
public static final int SEQ_STK_V_FUNC
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_STK_M_FUNC
```
public static final int SEQ_STK_M_FUNC
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_STK_V_LOOP
```
public static final int SEQ_STK_V_LOOP
```
    Public constants.
    
    See Also:
    Constant Field Values
  - SEQ_STK_M_COUNT
```
public static final int SEQ_STK_M_COUNT
```
    Public constants.
    
    See Also:
    Constant Field Values
  - lines
```
protected int[][] lines
```
    Fields.
  - times
```
protected int[][] times
```
  - prog
```
protected int[] prog
```
  - stack
```
protected int[] stack
```
  - stackSize
```
protected int stackSize
```
- Constructor Detail
  - Sequencer
```
public Sequencer(RegClient reg)
```
    Constructors.
  - Sequencer
```
public Sequencer()
```
- Method Detail
  - enable
```
public void enable()
            throws RcmException
```
    Enables the sequencer.
    
    Overrides:
    
    enable in class BaseSet
    
    Throws:
    
    RcmException
  - disable
```
public void disable()
             throws RcmException
```
    Disables the sequencer.
    
    Overrides:
    
    disable in class BaseSet
    
    Throws:
    
    RcmException
  - getTriggerTime
```
public long getTriggerTime()
                    throws RcmException
```
    Gets the sequencer trigger time.
    
    Returns:
    The Unix millisecond time of the sequencer trigger
    
    Throws:
    
    RcmException
  - writeLines
```
public void writeLines(int func,
              int slice,
              int value)
                throws RcmException
```
    Writes an output lines value.
    
    Parameters:
    func - The function number
    slice - The time slice number
    value - The output lines value
    
    Throws:
    
    RcmException
  - writeLines
```
public void writeLines(int func,
              int[] values)
                throws RcmException
```
    Writes a set of output lines values.
    
    Parameters:
    func - The function number
    values - The array of output lines values
    
    Throws:
    
    RcmException
  - writeLines
```
public void writeLines(int func,
              int[] values,
              int offset,
              int count)
                throws RcmException
```
    Writes a set of output lines values.
    
    Parameters:
    func - The function number
    values - The array of output lines values
    offset - The offset in values of the first value to write
    count - The number of values to write
    
    Throws:
    
    RcmException
  - writeTimes
```
public void writeTimes(int func,
              int slice,
              int value)
                throws RcmException
```
    Writes a time slice value.
    
    Parameters:
    func - The function number
    slice - The time slice number
    value - The time slice value
    
    Throws:
    
    RcmException
  - writeTimes
```
public void writeTimes(int func,
              int[] values)
                throws RcmException
```
    Writes a set of time slice values.
    
    Parameters:
    func - The function number
    values - The array of time slice values
    
    Throws:
    
    RcmException
  - writeTimes
```
public void writeTimes(int func,
              int[] values,
              int offset,
              int count)
                throws RcmException
```
    Writes a set of time slice values.
    
    Parameters:
    func - The function number
    values - The array of time slice values
    offset - The offset in values of the first value to write
    count - The number of values to write
    
    Throws:
    
    RcmException
  - writeStack
```
public void writeStack(int addr,
              int value)
                throws RcmException
```
    Writes a stack value.
    
    Parameters:
    addr - The stack address
    value - The value to write
    
    Throws:
    
    RcmException
  - writeStack
```
public void writeStack(int addr,
              int[] values)
                throws RcmException
```
    Writes a set of stack values.
    
    Parameters:
    addr - The first stack address
    values - The array of values to write
    
    Throws:
    
    RcmException
  - writeStack
```
public void writeStack(int addr,
              int[] values,
              int offset,
              int count)
                throws RcmException
```
    Writes a set of stack values.
    
    Parameters:
    addr - The first stack address
    values - The array of stack values to write
    offset - The offset in values of the first value to write
    count - The number of values to write
    
    Throws:
    
    RcmException
  - writeStack
```
public void writeStack(int[] values)
                throws RcmException
```
    Writes a complete set of stack values, setting the stack size.
    
    Parameters:
    values - The array of stack values to write
    
    Throws:
    
    RcmException
  - writeStack
```
public void writeStack(int[] values,
              int offset,
              int count)
                throws RcmException
```
    Writes a complete set of stack values, setting the stack size.
    
    Parameters:
    values - The array of stack values to write
    offset - The offset in values of the first item to write
    count - The number of values to write
    
    Throws:
    
    RcmException
  - writeStackSize
```
public void writeStackSize(int value)
                    throws RcmException
```
    Writes the stack size.
    
    Parameters:
    value - The value to write to the stack size register
    
    Throws:
    
    RcmException
  - writeProgram
```
public void writeProgram(int addr,
                int value)
                  throws RcmException
```
    Writes a program word.
    
    Parameters:
    addr - The program address
    value - The value to write
    
    Throws:
    
    RcmException
  - writeProgram
```
public void writeProgram(int addr,
                int[] values)
                  throws RcmException
```
    Writes a set of program words.
    
    Parameters:
    addr - The first program address
    values - The array of values to write
    
    Throws:
    
    RcmException
  - writeProgram
```
public void writeProgram(int addr,
                int[] values,
                int offset,
                int count)
                  throws RcmException
```
    Writes a set of program words.
    
    Parameters:
    addr - The first program address
    values - The array of program words to write
    offset - The offset in values of the first value to write
    count - The number of values to write
    
    Throws:
    
    RcmException
  - writeProgExec
```
public void writeProgExec(int addr,
                 int func,
                 int count)
                   throws RcmException
```
    Writes an execute program word.
    
    Parameters:
    addr - The program address
    func - The ID of the function to execute
    count - The number of times to execute the function
    
    Throws:
    
    RcmException
  - writeProgJump
```
public void writeProgJump(int addr,
                 int subaddr,
                 int count)
                   throws RcmException
```
    Writes a jump program word.
    
    Parameters:
    addr - The program address
    subaddr - The address of the subroutine to jump to
    count - The number of times to run the subroutine
    
    Throws:
    
    RcmException
  - writeProgEndSubr
```
public void writeProgEndSubr(int addr)
                      throws RcmException
```
    Writes an end subroutine word.
    
    Parameters:
    addr - The program address
    
    Throws:
    
    RcmException
  - writeProgEnd
```
public void writeProgEnd(int addr)
                  throws RcmException
```
    Writes an end program word.
    
    Parameters:
    addr - The program address
    
    Throws:
    
    RcmException
  - writeSliceCount
```
public void writeSliceCount(int value)
                     throws RcmException
```
    Writes the slice count.
    
    Parameters:
    value - The slice count value to write
    
    Throws:
    
    RcmException
  - writeDataSource
```
public void writeDataSource(int value)
                     throws RcmException
```
    Writes the data source register.
    
    Parameters:
    value - The value to write
    
    Throws:
    
    RcmException
  - writeBebSelect
```
public void writeBebSelect(int value)
                    throws RcmException
```
    Writes the BEB selector register.
    
    Parameters:
    value - The value to write
    
    Throws:
    
    RcmException
  - sendStep
```
public void sendStep()
              throws RcmException
```
    Sends the step command.
    
    Throws:
    
    RcmException
  - sendStop
```
public void sendStop()
              throws RcmException
```
    Sends the stop command.
    
    Throws:
    
    RcmException

Class Sequencer

Field Summary

Fields inherited from class org.lsst.ccs.drivers.rcm.BaseSet

Constructor Summary

Method Summary

Methods inherited from class org.lsst.ccs.drivers.rcm.BaseSet

Methods inherited from class org.lsst.ccs.drivers.rcm.RegClient

Methods inherited from class java.lang.Object

Field Detail

REG_SEQ_LINES

REG_SEQ_TIMES

REG_SEQ_STACK

REG_SEQ_PROGRAM

REG_SEQ_STEP

REG_SEQ_STOP

REG_SEQ_SSIZE

REG_SEQ_NSLICE

REG_SEQ_SOURCE

REG_SEQ_BEB

REG_SEQ_STEP_0

REG_SEQ_STOP_0

SEQ_MAX_FUNC_0

SEQ_MAX_FUNC

SEQ_MAX_SLICE

SEQ_MAX_PROGRAM

SEQ_MAX_STACK

SEQ_SRC_FPGA_PTN

SEQ_SRC_BEB_PTN

SEQ_SRC_BEB_ADC

SEQ_SRC_ADC

SEQ_SRC_PATTERN

SEQ_OPC_EXECUTE

SEQ_OPC_JUMP

SEQ_OPC_END_SUBR

SEQ_OPC_END_PROG

SEQ_PRG_V_OPCODE

SEQ_PRG_V_FUNC

SEQ_PRG_M_FUNC

SEQ_PRG_V_LOOP

SEQ_PRG_M_EXCCNT

SEQ_PRG_V_SUBADD

SEQ_PRG_M_SUBADD

SEQ_PRG_M_SUBCNT

SEQ_STK_V_FUNC

SEQ_STK_M_FUNC

SEQ_STK_V_LOOP

SEQ_STK_M_COUNT

lines

times

prog

stack

stackSize

Constructor Detail

Sequencer

Sequencer

Method Detail

enable

disable

getTriggerTime

writeLines

writeLines

writeLines

writeTimes

writeTimes

writeTimes

writeStack

writeStack

writeStack

writeStack

writeStack

writeStackSize

writeProgram

writeProgram

writeProgram

writeProgExec

writeProgJump

writeProgEndSubr

writeProgEnd

writeSliceCount

writeDataSource