Class StateBase`Abstract`

The base implementation of the State interface.

Hierarchy

StateBase

Implements

State

Index

Constructors

Properties

Methods

acceptVisitor checkStartingState uninstall

Constructors

`Protected` constructor

new StateBase(stateMachine, stateName): StateBase
Creates the state.
Parameters
- stateMachine: FSM
  The FSM that will contain the state.
- stateName: string
  The name of this state.
Returns StateBase
- Defined in impl/fsm/StateBase.ts:33

Properties

`Readonly` fsm

fsm: FSM

The FSM that contains the state.

`Readonly` name

name: string

The name of the state.

Methods

`Abstract` acceptVisitor

acceptVisitor(visitor): void
Visiting the state.
Parameters
- visitor: VisitorFSM
  The visitor.
Returns void
Implementation of State.acceptVisitor
- Defined in impl/fsm/StateBase.ts:46

checkStartingState

checkStartingState(): void
Checks whether the starting state of the fsm is this state. In this case, the fsm is notified about the starting of the FSM.

Returns void
Throws
CancelFSMException
Implementation of State.checkStartingState
- Defined in impl/fsm/StateBase.ts:38

uninstall

uninstall(): void
Uninstall (ie flushes) the state. Useful to clear data. The state must not be used after that.

Returns void
Implementation of State.uninstall
- Defined in impl/fsm/StateBase.ts:44

Generated using TypeDoc