Class InitState

An FSM state. An initial state is the unique state that can start an FSM.

Hierarchy

OutputStateBase
- InitState

Index

Constructors

Properties

_transitions fsm name

Accessors

Methods

acceptVisitor addTransition checkStartingState clearTransitions exit process uninstall

Constructors

constructor

new InitState(stateMachine, stateName): InitState
Parameters
- stateMachine: FSM
- stateName: string
Returns InitState
Overrides OutputStateBase.constructor
- Defined in impl/fsm/InitState.ts:25

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
Overrides OutputStateBase.acceptVisitor
- Defined in impl/fsm/InitState.ts:33

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
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

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/InitState.ts:29

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
Inherited from OutputStateBase.uninstall
- Defined in impl/fsm/OutputStateBase.ts:66

Generated using TypeDoc