Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Vertex

A vertex is an element that can be the source or target of a transition.

Hierarchy

  • NamedElement<Region | undefined>
    • Vertex

Implemented by

Index

Properties

Methods

Properties

name

name: String

The name of the named element.

outgoing

outgoing: Array<Transition>

The set of outgoind transitions from the vertex.

internal

parent

parent: Region | undefined

The parent element of the named element.

qualifiedName

qualifiedName: string

The fully qualified name of the named element, including parent names.

Methods

enter

  • enter(instance: IInstance, deepHistory: boolean, trigger: any): void

  • Parameters

    • instance: IInstance
    • deepHistory: boolean
    • trigger: any

    Returns void

enterHead

  • enterHead(instance: IInstance, deepHistory: boolean, trigger: any, nextElement: NamedElement | undefined): void

  • Parameters

    • instance: IInstance
    • deepHistory: boolean
    • trigger: any
    • nextElement: NamedElement | undefined

    Returns void

enterTail

  • enterTail(instance: IInstance, deepHistory: boolean, trigger: any): void

  • Parameters

    • instance: IInstance
    • deepHistory: boolean
    • trigger: any

    Returns void

getTransition

  • getTransition<TTrigger>(trigger: TTrigger): Transition | undefined

  • Returns the transition to take given a trigger event.

    throws

    Throws an Error exception if the state machine model is malformed.

    internal

    Type parameters

    • TTrigger

    Parameters

    • trigger: TTrigger

      The trigger event.

    Returns Transition | undefined

    Returns the transition to take in response to the trigger, of undefined if none found.

leave

  • leave(instance: IInstance, deepHistory: boolean, trigger: any): void

  • Parameters

    • instance: IInstance
    • deepHistory: boolean
    • trigger: any

    Returns void

toString

  • toString(): string

Generated using TypeDoc