Class JSONInstance

Manages the active state configuration of a state machine instance using a serializable JSON structure.

Hierarchy

JSONInstance

Implements

IInstance

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new JSONInstance(name?: string): JSONInstance

- Defined in state.ts:610
Creates a new instance of the JSONInstance class.

Parameters
- Default value name: string = "unnamed"
  
  The optional name of the JSONInstance.
Returns JSONInstance

Properties

current

current: object

internal

Type declaration

[id: string]: Vertex

isTerminated

isTerminated: boolean = false

Indicates that the state machine instance has reached a PseudoStateKind.Terminate PseudoState and therfore will no longer respond to messages.

name

name: string

The optional name of the JSONInstance.

Methods

fromJSON

fromJSON(json: string): any

- Defined in state.ts:681
Sets the active state configuration from a JSON string.

Parameters
- json: string
  
  A JSON string representation of the active state configuration.
Returns any

getCurrent

getCurrent(region: Region): Vertex | undefined

Implementation of IInstance.getCurrent
- Defined in state.ts:636
Returns the last known Vertex for a given Region.

Parameters
- region: Region
  
  The Region to get the last known Vertex of.
Returns Vertex | undefined

The last known Vertex of the given Region.

getLastKnownState

getLastKnownState(region: Region): State | undefined

Implementation of IInstance.getLastKnownState
- Defined in state.ts:645
Returns the last known State for a given Region.

Parameters
- region: Region
  
  The Region to get the last known State of.
Returns State | undefined

The last known State of the given Region.

setCurrent

setCurrent(region: Region, vertex: Vertex): void

Implementation of IInstance.setCurrent
- Defined in state.ts:623
Updates the last known State for a given Region.

Parameters
- region: Region
  
  The Region to set the last known State of.
- vertex: Vertex
  
  The last known Vertex of the given Region.
Returns void

toJSON

toJSON(): string

- Defined in state.ts:673
Returns the active state configuration as a JSON string.

Returns string

A JSON string representation of the active state configuration.

toString

toString(): string

- Defined in state.ts:689
Returns the name of the StateMachineInstance.

Returns string

The name of this StateMachineInstance.

Generated using TypeDoc