Hierarchy
-
FiniteStateMachineB
- ProgramFiniteStateMachineB
Index
Properties
Methods
Properties
currentState
Current state CurrentState stores the current state of an instance of the StateMachineType. CurrentState provides a human readable name for the current state which may not be suitable for use in application control logic. Applications should use the Id Property of CurrentState if they need a nique identifier for the state.
currentStateNode
Readonly halt
Halt Causes the Program to transition from the Ready, Running or Suspended state to the Halted state.
Readonly halted
Readonly haltedToReady
Readonly initialState
Optional lastTransition
Last transition
LastTransition stores the last transition which occurred in an instance of the StateMachineType. LastTransition provides a human readable name.
Readonly ready
Readonly readyToHalted
Readonly readyToRunning
reset
Reset Causes the Program to transition from the Halted state to the Ready state
Readonly resume
Resume Causes the Program to transition from the Suspended state to the Running state.
Readonly running
Readonly runningToHalted
Readonly runningToReady
Readonly runningToSuspended
Readonly start
Start Causes the Program to transition from the Ready state to the Running state.
Readonly states
Readonly suspend
Suspend Causes the Program to transition from the Running state to the Suspended state.
Readonly suspended
Readonly suspendedToHalted
Readonly suspendedToReady
Readonly suspendedToRunning
Readonly transitions
Methods
findTransitionNode
-
try to find the valid transition between fromState Node to toState Node
Parameters
-
fromStateNode: State
-
toStateNode: State
-
Optional predicate: TransitionSelector
Returns Transition
-
getCurrentState
-
return the current state as string
Returns string
getStateByName
-
return the state Node by Name
Parameters
-
name: string
Returns State
-
getStates
-
return all state nodes associated with this state machine
Returns State[]
getTransitions
-
return all state to state transition node associated with this state machine
Returns Transition[]
isValidTransition
-
returns true if there is a valid transition from currentStateNode to toStateNode
Parameters
-
toStateNode: string | State
-
Optional predicate: TransitionSelector
Returns boolean
-
setState
-
change the current state
note:
- a transition from currentState to toState node must exists
- a TransitionEventType event will be raised
Parameters
-
toStateNode: string | State
-
Optional predicate: TransitionSelector
Returns void
Program Finite State Machine
as per part 10 : Program Specification
A standard set of base states is defined for Programs as part of the Program Finite State Machine. These states represent the stages in which a Program can exist at an instance in time as viewed by a Client. This state is the Program’s current state. All Programs shall support this base set. A Program may or may not require a Client action to cause the state to change. The states are formally defined in Table 2.
Table 2 – Program states | State | Description |-----------|-------------------------------------------------------------------------------------| | Ready | The Program is properly initialized and may be started. | | Running | The Program is executing making progress towards completion. | | Suspended | The Program has been stopped prior to reaching a terminal state but may be resumed. | | Halted | The Program is in a terminal or failed state, and it cannot be started or resumed without being reset|
The set of states defined to describe a Program can be expanded. Program sub states can be defined for the base states to provide more resolution of a process and to describe the cause and effect(s) of additional stimuli and transitions. Standards bodies and industry groups may extend the base Program Finite State Model to conform to various industry models. For example, the Halted state can include the sub states “Aborted” and “Completed” to indicate if the function achieved a successful conclusion prior to the transition to Halted.