org.lsst.ccs.drivers.reb.sim

Class SequencerSimulation

java.lang.Object

org.lsst.ccs.drivers.reb.sim.SequencerSimulation

public class SequencerSimulation
extends Object

Simulate the REB3 sequencer. The simulation allows programs to be loaded and run. Support is included for start, step and stop functions. Listeners can be attached to listen for start/stop transitions, function calls, and to listen to output transitions (waveforms). Most of the functionality of the sequencer is controlled by manipulating its registers using the AddressSpace object passed to the constructor.

Author:

tonyj

See Also:

Sequencer User Guide

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SequencerSimulation.FinalState An object of this class can be obtained from the future returned by the start method.
static interface	SequencerSimulation.FunctionListener A function listener is called any time a function is called.
static class	SequencerSimulation.State
static interface	SequencerSimulation.StateListener A state listener is called any time the sequencer state changes.
static interface	SequencerSimulation.SubroutineListener A subroutine listener is called any time a subroutine starts or ends
static interface	SequencerSimulation.WaveformListener A waveform listener is called any time an output transitions

Constructor Summary

Constructors

Constructor and Description
SequencerSimulation(AddressSpace addressSpace) Create a sequencer simulator.

Method Summary

Modifier and Type	Method and Description
void	addFunctionListener(SequencerSimulation.FunctionListener l) Add a function listener.
void	addStateListener(SequencerSimulation.StateListener l) Add a state change listener.
void	addSubroutineListener(SequencerSimulation.SubroutineListener l) Add a subroutine listener.
void	addWaveformListener(SequencerSimulation.WaveformListener l) Add a waveform listener to listen to changes of the output waveforms.
int	getMaxFunctionRepetitions() The current maximum function repetition count.
int	getMaxSubroutineRepetitions() The current maximum subroutine repetition count.
int	getRenormalization() Get the number of times infinite loops will actually repeat.
SequencerSimulation.State	getState() Get the current state of the simulator.
void	removeFunctionListener(SequencerSimulation.FunctionListener l) Remove a function listener.
void	removeStateListener(SequencerSimulation.StateListener l) Remove a state change listener.
void	removeSubroutineListener(SequencerSimulation.SubroutineListener l) Remove a subroutine listener.
void	removeWaveformListener(SequencerSimulation.WaveformListener l) Remove a waveform listener.
void	setMaxFunctionRepetitions(int maxFunctionRepetitions) Allows the maximum repetition count for functions to be arbitrarily limited.
void	setMaxSubroutineRepetitions(int maxSubroutineRepetitions) Allows the maximum repetition count for subroutines to be arbitrarily limited.
void	setRenormalization(int renormalization) Limits how many times infinite loops will actually repeat.
void	shutdown() Shutdown the simulator, stopping any programs currently running.
Future<SequencerSimulation.FinalState>	start() Start the sequencer.
Future<SequencerSimulation.FinalState>	trigger(int opcode) Simulates use of the global proc method for starting or stopping the sequencer using opcodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

SequencerSimulation

public SequencerSimulation(AddressSpace addressSpace)

Create a sequencer simulator.

Parameters:

addressSpace - The address space to which the sequencer will add its registers.

Method Detail

trigger

public Future<SequencerSimulation.FinalState> trigger(int opcode)

Simulates use of the global proc method for starting or stopping the sequencer using opcodes.

Parameters:

opcode - The opcode (0-31). Opcode 31 means step.

Returns:

A future which can be used to obtain the final state of the sequencer when it finishes due to reaching the end of a program, or due to an error. Will be null for opcode 31.

start

public Future<SequencerSimulation.FinalState> start()

Start the sequencer. This function returns immediately, and execution of the sequencer continues on a separate thread. This method does wait for the sequencer thread to start, to ensure that a test of the sequencer state immediately after calling this method will reflect that the sequencer has started.

Returns:

A future which can be used to obtain the final state of the sequencer when it finishes due to reaching the end of a program, or due to an error.

shutdown

public void shutdown()

Shutdown the simulator, stopping any programs currently running.

getState

public SequencerSimulation.State getState()

Get the current state of the simulator.

Returns:

getMaxSubroutineRepetitions

public int getMaxSubroutineRepetitions()

The current maximum subroutine repetition count.

Returns:

The current subroutine repetition limit, or 0 if unlimited.

See Also:

setMaxSubroutineRepetitions(int)

setMaxSubroutineRepetitions

public void setMaxSubroutineRepetitions(int maxSubroutineRepetitions)

Allows the maximum repetition count for subroutines to be arbitrarily limited. Any subroutine call which specifies a larger repetition count will actually only repeat this number of times.

Parameters:

maxSubroutineRepetitions - The maximum number of repetitions, or 0 to remove any limit.

getMaxFunctionRepetitions

public int getMaxFunctionRepetitions()

The current maximum function repetition count.

Returns:

The current function repetition limit, or 0 if unlimited.

See Also:

setMaxFunctionRepetitions(int)

setMaxFunctionRepetitions

public void setMaxFunctionRepetitions(int maxFunctionRepetitions)

Allows the maximum repetition count for functions to be arbitrarily limited. Any function call which specifies a larger repetition count will actually only repeat this number of times.

Parameters:

maxFunctionRepetitions - The maximum number of repetitions, or 0 to remove any limit.

getRenormalization

public int getRenormalization()

Get the number of times infinite loops will actually repeat.

Returns:

The repeat count, or 0 to indicate unlimited.

See Also:

setRenormalization(int)

setRenormalization

public void setRenormalization(int renormalization)

Limits how many times infinite loops will actually repeat.

Parameters:

renormalization - The number of repetitions used for infinite loops, or 0 to indicate no limit.

addStateListener

public void addStateListener(SequencerSimulation.StateListener l)

Add a state change listener. Note that the state change listener will be called on the sequencer execution thread.

Parameters:

l - The state change listener

removeStateListener

public void removeStateListener(SequencerSimulation.StateListener l)

Remove a state change listener.

Parameters:

l - The state change listener

addSubroutineListener

public void addSubroutineListener(SequencerSimulation.SubroutineListener l)

Add a subroutine listener. Note that the subroutine listener will be called on the sequencer execution thread.

Parameters:

l - The subroutine listener

removeSubroutineListener

public void removeSubroutineListener(SequencerSimulation.SubroutineListener l)

Remove a subroutine listener.

Parameters:

l - The subroutine listener.

addFunctionListener

public void addFunctionListener(SequencerSimulation.FunctionListener l)

Add a function listener. Note that the function listener will be called on the sequencer execution thread.

Parameters:

l - The function listener

removeFunctionListener

public void removeFunctionListener(SequencerSimulation.FunctionListener l)

Remove a function listener.

Parameters:

l - The function listener.

addWaveformListener

public void addWaveformListener(SequencerSimulation.WaveformListener l)

Add a waveform listener to listen to changes of the output waveforms. Note that registering a waveform listener causes the simulator to start executing individual function repetitions, and thus slows the simulator down considerably. Note that infinite loops do not currently result in a unlimited number of calls to the waveform listener.

Parameters:

l - The waveform listener.

removeWaveformListener

public void removeWaveformListener(SequencerSimulation.WaveformListener l)

Remove a waveform listener.

Parameters:

l - The waveform listener.