Class OutputStateBase`Abstract`

Base implementation of the OutputState interface.

Hierarchy

StateBase
- OutputStateBase
  - InitState
  - StdState

Implements

OutputState

Index

Constructors

Properties

_transitions fsm name

Accessors

Methods

acceptVisitor addTransition checkStartingState clearTransitions exit process uninstall

Constructors

`Protected` constructor

new OutputStateBase(stateMachine, stateName): OutputStateBase
Creates the state.
Parameters
- stateMachine: FSM
  The FSM that will contain the state.
- stateName: string
  The name of this state.
Returns OutputStateBase
Overrides StateBase.constructor
- Defined in impl/fsm/OutputStateBase.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>[]
Implementation of OutputState.transitions
- Defined in impl/fsm/OutputStateBase.ts:56

Methods

`Abstract` acceptVisitor

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

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

clearTransitions

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

`Abstract` 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.
Implementation of OutputState.exit
- Defined in impl/fsm/OutputStateBase.ts:64

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
Implementation of OutputState.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 OutputState.uninstall
Overrides StateBase.uninstall
- Defined in impl/fsm/OutputStateBase.ts:66

Generated using TypeDoc