com.opencloud.sce.fsmtool

Interface SbbStateMachine<ReturnCode extends Enum<ReturnCode>>

public interface SbbStateMachine<ReturnCode extends Enum<ReturnCode>>

Interface for a finite state machine SBB class.

When an input is received the receivedInput() method is called. The state machine implementation will execute all input, exit and entry actions which are defined in the FSM.

Method Summary

Methods

Modifier and Type	Method and Description
ReturnCode	execute() Notify the state machine that an input has arrived and process it.
String	getDescription()
InputScheduler<FSMInput>	getInputScheduler()
int	getMaxExecutionCycles()
String	getName()
boolean	isExecuting()
void	setMaxExecutionCycles(int maxExecutionCycles)

Method Detail

execute

ReturnCode execute()

Notify the state machine that an input has arrived and process it. All output actions will be processed before this method returns

Parameters:

input - input to set in the input register of the state machine

Returns:

number of transitions or -1 if there was an error

getInputScheduler

InputScheduler<FSMInput> getInputScheduler()

getName

String getName()

Returns:

name of the state machine

getDescription

String getDescription()

Returns:

description of the state machine

isExecuting

boolean isExecuting()

getMaxExecutionCycles

int getMaxExecutionCycles()

setMaxExecutionCycles

void setMaxExecutionCycles(int maxExecutionCycles)