Options
All
  • Public
  • Public/Protected
  • All
Menu

Class State

A Vertex within a StateMachine model that represents an invariant condition within the life of the state machine instance.

State instances are one of the fundamental building blocks of the StateMachine model; they typically represent conditions where the machine is awaiting an eveny to trigger a Transition. User-defined Actions can be defined for both State entry and State exit.

Hierarchy

Index

Constructors

constructor

Properties

defaultRegion

defaultRegion: Region
internal

entryBehavior

entryBehavior: Action[] = new Array<Action>()
internal

exitBehavior

exitBehavior: Action[] = new Array<Action>()
internal

incoming

incoming: Transition[] = new Array<Transition>()

The Transitions targeting this Vertex.

name

name: string

The name of the NamedElement.

outgoing

outgoing: Transition[] = new Array<Transition>()

The Transitions originating from this Vertex.

parent

parent: Region | undefined

The parent of this Element

qualifiedName

qualifiedName: string
internal

regions

regions: Region[] = new Array<Region>()

The Region instances that are a child of this State.

Static namespaceSeparator

namespaceSeparator: string = "."

The symbol used to separate NamedElement names within a fully qualified name. Change this static member to create different styles of qualified name generated by the toString method.

Methods

accept

  • accept<TArg1>(visitor: Visitor<TArg1>, arg1?: TArg1): void

ancestry

entry

  • entry(entryAction: Action): this

exit

  • exit(exitAction: Action): this

getDefaultRegion

getRoot

isComposite

  • isComposite(): boolean

isFinal

  • isFinal(): boolean

isOrthogonal

  • isOrthogonal(): boolean

isSimple

  • isSimple(): boolean

remove

  • remove(): void

to

toString

  • toString(): string

Generated using TypeDoc