public interface AbstractStateMachine_listener
This interface is a management utility (including visualization issues),
which can be implemented by a state machine manager object. This object is
intended to get information about the discrete evolution of a state machine.
It provides basic services so that this manager object is able to be informed
of cyclic changes coming from the managed component (i.e., that owning
the state machine).
Compatibility: PauWare Java EE (Java SE/Java EE) and PauWare Java ME (Java SE/Java ME).
- Since:
- 1.0
-
Method Summary
Modifier and Type Method Description void
post_construct(AbstractStateMachine state_machine)
This method pushes (communicates) the initial structure of a state machine.void
pre_destroy()
This method is called after a state machine has been stopped.void
run_to_completion(java.lang.String verbose, java.util.HashMap<Transition,java.lang.Object[]> execution)
This method pushes (communicates) the detailed result of an execution (trace) in a verbose mode just after a state machine execution; it also communicates the effective triggered transitions.void
start(java.lang.String verbose)
This method is called when entering an entire state machine; it is called within theAbstractStateMachine.start()
method.void
stop(java.lang.String verbose)
This method is called when exiting an entire state machine; it is called within theAbstractStateMachine.stop()
method.
-
Method Details
-
post_construct
This method pushes (communicates) the initial structure of a state machine. Such a structure includes all of the states, their relationships and the cached transitions, i.e., those declared before calling theAbstractStateMachine.start()
method.- Parameters:
state_machine
- the state machine itself.- Throws:
java.lang.Exception
-
start
void start(java.lang.String verbose) throws java.lang.ExceptionThis method is called when entering an entire state machine; it is called within theAbstractStateMachine.start()
method.- Parameters:
verbose
- A string stating what happened.- Throws:
java.lang.Exception
-
run_to_completion
void run_to_completion(java.lang.String verbose, java.util.HashMap<Transition,java.lang.Object[]> execution) throws java.lang.ExceptionThis method pushes (communicates) the detailed result of an execution (trace) in a verbose mode just after a state machine execution; it also communicates the effective triggered transitions. This occurs after a run-to-completion cycle.- Parameters:
verbose
- A string stating what happened.execution
- The set ofTransition
objects (keys) and their associated actions (values are Java primitive arrays ofAbstractAction
.- Throws:
java.lang.Exception
-
stop
void stop(java.lang.String verbose) throws java.lang.ExceptionThis method is called when exiting an entire state machine; it is called within theAbstractStateMachine.stop()
method.- Parameters:
verbose
- A string stating what happened.- Throws:
java.lang.Exception
-
pre_destroy
void pre_destroy() throws java.lang.ExceptionThis method is called after a state machine has been stopped.- Throws:
java.lang.Exception
-