Interface FSM

A finite state machine that defines the behavior of a user interaction.

interface FSM {
    currentState: OutputState;
    currentStateObservable: Observable<[OutputState, OutputState]>;
    currentSubFSM: undefined | FSM;
    initState: OutputState;
    inner: boolean;
    log: boolean;
    started: boolean;
    startingState: State;
    states: readonly State[];
    acceptVisitor(visitor): void;
    addHandler(handler): void;
    enterStdState(state): void;
    fullReinit(): void;
    onCancelling(): void;
    onError(err): void;
    onStarting(): void;
    onTerminating(): void;
    onTimeout(): void;
    onUpdating(): void;
    process(event): boolean;
    reinit(): void;
    removeHandler(handler): void;
    stopCurrentTimeout(): void;
    uninstall(): void;
}

Hierarchy

Implemented by

Properties

currentState currentStateObservable currentSubFSM initState inner log started startingState states

Methods

acceptVisitor addHandler enterStdState fullReinit onCancelling onError onStarting onTerminating onTimeout onUpdating process reinit removeHandler stopCurrentTimeout uninstall

Properties

currentState

currentState: OutputState

The current state of the FSM.

Readonly currentStateObservable

currentStateObservable: Observable<[OutputState, OutputState]>

An observable value for observing the current state of FSM during its execution.

currentSubFSM

currentSubFSM: undefined | FSM

The current sub FSM in which this FSM is while running.

Readonly initState

initState: OutputState

The initial state of the FSM

inner

inner: boolean

Defines whether the FSM is an inner FSM (ie, whether it is included into another FSM as a sub-FSM transition).

log

log: boolean

Logs (or not) information about the execution of the FSM.

Readonly started

started: boolean

True: The FSM started.

Readonly startingState

startingState: State

By default an FSM triggers its 'start' event when it leaves its initial state. In some cases, this is not the case. For example, a double-click interaction is an FSM that must trigger its start event when the FSM reaches... its terminal state. Similarly, a DnD must trigger its start event on the first move, not on the first press. The goal of this attribute is to identify the state of the FSM that must trigger the start event. By default, this attribute is set with the initial state of the FSM.

Readonly states

states: readonly State[]

The set of the states that compose the FSM. This returns a copy of the real set.

Methods

acceptVisitor

addHandler

enterStdState

fullReinit

  • fullReinit(): void

  • Reinitialises the FSM. Compared to [[FSM#reinit]] this method flushes the remaining events to process.

    Returns void

onCancelling

  • onCancelling(): void

  • Cancels the state machine.

    Returns void

onError

  • onError(err): void

  • Processes an error produced in the FSM.

    Parameters

    • err: unknown

      The error to treat.

    Returns void

onStarting

onTerminating

  • onTerminating(): void

  • Terminates the state machine.

    Returns void

onTimeout

  • onTimeout(): void

  • Jobs to do when a timeout transition is executed. Because the timeout transition is based on a separated thread, the job done by this method must be executed in the UI thread. UI Platforms must override this method to do that.

    Returns void

onUpdating

  • onUpdating(): void

  • Updates the state machine.

    Returns void

process

  • process(event): boolean

  • Processes the provided event to run the FSM.

    Parameters

    • event: Event

      The event to process.

    Returns boolean

    True: the FSM correctly processed the event.

reinit

  • reinit(): void

  • Reinitialises the FSM. Remaining events to process are however not clear. See [[FSM#fullReinit]] for that.

    Returns void

removeHandler

  • removeHandler(handler): void

  • Removes the given FSM handler from this FSM.

    Parameters

    Returns void

stopCurrentTimeout

  • stopCurrentTimeout(): void

  • Stops the current timeout transition.

    Returns void

uninstall

  • uninstall(): void

  • Uninstall the FSM. Useful for flushing memory. The FSM must not be used after that.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc