Class StdState

An FSM state. A standard state can compose an FSM. They do not start, stop, cancel an FSM. They accept input and output events.

Hierarchy

OutputStateBase
- StdState

Implements

InputState

Index

Constructors

Properties

_transitions fsm name

Accessors

Methods

acceptVisitor addTransition checkStartingState clearTransitions enter exit process uninstall

Constructors

constructor

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

Properties

`Protected` `Readonly` _transitions

_transitions: Transition<Event>[]

`Readonly` fsm

fsm: FSM

The FSM that contains the state.

`Readonly` name

name: string

The name of the state.

Accessors

transitions

get transitions(): readonly Transition<Event>[]
The list of outgoing transitions of the state.

Returns readonly Transition<Event>[]
Inherited from OutputStateBase.transitions
- Defined in impl/fsm/OutputStateBase.ts:56

Methods

acceptVisitor

acceptVisitor(visitor): void
Visiting the state.
Parameters
- visitor: VisitorFSM
  The visitor.
Returns void
Implementation of InputState.acceptVisitor
Overrides OutputStateBase.acceptVisitor
- Defined in impl/fsm/StdState.ts:44

addTransition

addTransition(tr): void
Adds the given transitions to the list of outgoing transitions of the state.
Parameters
- tr: Transition<Event>
  The transition to add.
Returns void
Inherited from OutputStateBase.addTransition
- Defined in impl/fsm/OutputStateBase.ts:60

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 InputState.checkStartingState
Inherited from OutputStateBase.checkStartingState
- Defined in impl/fsm/StateBase.ts:38

clearTransitions

clearTransitions(): void
Returns void
Inherited from OutputStateBase.clearTransitions
- Defined in impl/fsm/OutputStateBase.ts:52

enter

enter(): void
Actions done while entering this state.

Returns void
Throws
CancelFSMException If entering the state leads to a cancelling of the FSM execution.
Implementation of InputState.enter
- Defined in impl/fsm/StdState.ts:37

exit

exit(): void
Actions done when a transition of the state is executed so that this state is left.

Returns void
Throws
CancelFSMException If leaving the state leads to a cancelling of the FSM execution.
Overrides OutputStateBase.exit
- Defined in impl/fsm/StdState.ts:42

process

process(event): boolean
Asks to the state to process of the given event.
Parameters
- event: Event
  The event to process. Can be null.
Returns boolean
Inherited from OutputStateBase.process
- Defined in impl/fsm/OutputStateBase.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 InputState.uninstall
Inherited from OutputStateBase.uninstall
- Defined in impl/fsm/OutputStateBase.ts:66

Generated using TypeDoc