Class SubFSMTransition

A transition that refers to another FSM. Entering this transition starts the underlying sub-FSM. To leave the transition, the sub-FSM must end.

Hierarchy

TransitionBase<Event>
- SubFSMTransition

Index

Constructors

Properties

action guard src subFSM subFSMHandler subStateSubscription? tgt

Accessors

Methods

accept acceptVisitor cancelsFSM execute findTransition getAcceptedEvents setUpFSMHandler uninstall unsetFSMHandler

Constructors

constructor

new SubFSMTransition(srcState, tgtState, fsm, action?): SubFSMTransition
Creates the transition.
Parameters
- srcState: OutputState
  The source state of the transition.
- tgtState: InputState
  The output state of the transition.
- fsm: FSM
  The inner FSM that composes the transition.
- Optional action: ((evt) => void)
  The action to execute when going through the transition
  - - (evt): void
    - Parameters
      evt: Event
      Returns void
Returns SubFSMTransition
Overrides TransitionBase.constructor
- Defined in impl/fsm/SubFSMTransition.ts:50

Properties

`Readonly` action

action: ((evt) => void)

Type declaration

- (evt): void
- Parameters
  - evt: Event
  Returns void

`Readonly` guard

guard: ((evt) => boolean)

Type declaration

- (evt): boolean
- Parameters
  - evt: Event
  Returns boolean

`Readonly` src

src: OutputState

`Private` `Readonly` subFSM

subFSM: FSM

`Private` `Readonly` subFSMHandler

subFSMHandler: FSMHandler

`Private` `Optional` subStateSubscription

subStateSubscription?: Subscription

Temporary subscription to the current state of the sub-FSM.

`Readonly` tgt

tgt: InputState

Accessors

target

get target(): InputState
The target state of the transition

Returns InputState
Inherited from TransitionBase.target
- Defined in impl/fsm/TransitionBase.ts:69

Methods

accept

accept(event): event is Event
Parameters
- event: Event
Returns event is Event
Overrides TransitionBase.accept
- Defined in impl/fsm/SubFSMTransition.ts:127

acceptVisitor

acceptVisitor(visitor): void
Visiting the transition.
Parameters
- visitor: VisitorFSM
  The visitor.
Returns void
Inherited from TransitionBase.acceptVisitor
- Defined in impl/fsm/TransitionBase.ts:63

`Private` cancelsFSM

cancelsFSM(): void
Returns void
- Defined in impl/fsm/SubFSMTransition.ts:109

execute

execute(event): undefined | InputState
Executes the transition.
Parameters
- event: Event
  The event to process.
Returns undefined | InputState
The potential output state.

Throws
CancelFSMException If the execution cancels the FSM execution.
Overrides TransitionBase.execute
- Defined in impl/fsm/SubFSMTransition.ts:114

`Private` findTransition

findTransition(event): undefined | Transition<Event>
Parameters
- event: Event
Returns undefined | Transition<Event>
- Defined in impl/fsm/SubFSMTransition.ts:131

getAcceptedEvents

getAcceptedEvents(): ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">
Returns ReadonlySet<"input" | "auxclick" | "change" | "click" | "keydown" | "keyup" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "scroll" | "touchend" | "touchmove" | "touchstart" | "wheel">
The set of events accepted by the transition.
Overrides TransitionBase.getAcceptedEvents
- Defined in impl/fsm/SubFSMTransition.ts:138

`Private` setUpFSMHandler

setUpFSMHandler(): void
When has to setting up the subFSM

Returns void
- Defined in impl/fsm/SubFSMTransition.ts:90

uninstall

uninstall(): void
Clean the transition when not used anymore.

Returns void
Overrides TransitionBase.uninstall
- Defined in impl/fsm/SubFSMTransition.ts:149

`Private` unsetFSMHandler

unsetFSMHandler(): void
If the subFSM is not more used to should be unset.

Returns void
- Defined in impl/fsm/SubFSMTransition.ts:103

Generated using TypeDoc