Interface FsmTransition<StateT>
- Type Parameters:
StateT- The enum type representing the states of the machine this transition belongs to.
public interface FsmTransition<StateT>
Callback handed to every
FsmState hook and every FsmHook, used to request a transition to a new
state.
Calling either method from within FsmState.enter(FsmContext, FsmTransition) is fully supported and
re-entrant: the FiniteStateMachine will immediately exit the state just entered and enter the requested one -
useful for entry guards (e.g. "if a fault is already present on entry, go straight to the fault state").
Calling either method does not stop the current method from running. The exit/enter cycle runs immediately and
then control returns right back to the calling hook - any code after the call still executes, as part of the state
that was just exited. If a hook has nothing more to do once it transitions, it should return right after
calling this.
-
Method Summary
Modifier and TypeMethodDescriptionvoidforceTransitionTo(StateT nextState) Requests a transition tonextStateunconditionally, even if the machine is already there - in which case this still runs a full exit/enter cycle and resetsexecutionsInState/timeInState(though, like any self-transition, it is not logged, since nothing - as far as an outside observer is concerned - actually changed).voidtransitionTo(StateT nextState) Requests a transition tonextState- a safe no-op if the machine is already in it.
-
Method Details
-
transitionTo
Requests a transition tonextState- a safe no-op if the machine is already in it. This is the one to reach for by default, especially from aFsmHookor any condition that gets re-evaluated every cycle (a fault check, an "is input active" check): calling it again on a later cycle while the condition is still true does nothing, rather than running a spurious exit/enter cycle and resettingexecutionsInState/timeInStateevery tick.- Parameters:
nextState- The state to transition to, if the machine isn't already in it.
-
forceTransitionTo
Requests a transition tonextStateunconditionally, even if the machine is already there - in which case this still runs a full exit/enter cycle and resetsexecutionsInState/timeInState(though, like any self-transition, it is not logged, since nothing - as far as an outside observer is concerned - actually changed). Use this when you deliberately want that reset, e.g. to periodically "restart the clock" on the current state without changing behavior. For the common case of a condition that might already be satisfied, usetransitionTo(Object)instead.- Parameters:
nextState- The state to transition to.
-