Creates a new instance of the State class.
The name of the state.
The parent region of the state or a state whose default region will be used as the parent region. If left undefined, this state is the root state in a state machine model.
The child regions belonging to this state.
The default region used when creating state machine models with implicit regions.
The list of types that this state can defer to the event pool.
The name of the state.
The behaviour to each time the state is entered.
The behaviour to perform each time the is state exited.
The outgoing transitions available from this vertex.
The parent element of the state.
The fully qualified name of the vertex including its parent's qualified name.
Marks a particular type of event for deferral if it is not processed by the state. Deferred events are placed in the event pool for subsiquent evaluation.
The type of event that this state will defer.
Returns the state.
Adds behaviour to the state to be called every time the state is entered.
The behaviour to call on state entry.
Returns the state.
Adds behaviour to the state to be called every time the state is exited.
The behaviour to call on state exit.
Returns the state.
Creates a new external transition.
The type of the trigger event that may cause the transition to be traversed.
The target vertex of the external transition.
The external transition.
Returns the default state of the region; creates one if it does not already exist.
Returns the default region.
Returns the transition to take given a trigger event.
The trigger event.
Returns the transition to take in response to the trigger, of undefined if none found.
Creates a new internal transition.
The type of the trigger event that may cause the transition to be traversed.
Returns the internal transition.
Tests the state to see if it is a composite state (having one or more child regions).
True if the state has one or more child regions.
Returns true if the state is a final state. A final state is one that has no outgoing transitions therefore no more state transitions can occur in it's parent region.
Tests the state to see if it is a composite state (having two or more child regions).
True if the state has two or more child regions.
Tests the state to see if it is a simple state (having no child regions).
True if the state has no child regions.
Creates a new local transition.
The type of the trigger event that may cause the transition to be traversed.
The target vertex of the local transition.
Returns the local transition.
Creates a new transition with a type test.
The type of event that this transition will look for.
Returns the newly created transition.
Creates a new external transition.
The type of the trigger event that may cause the transition to be traversed.
The target vertex of the external transition.
If target is specified, returns an external transition otherwide an internal transition.
Returns the fully qualified name of the state.
Creates a new internal transition with a guard condition.
The guard condition to add.
Returns the new transition.
Generated using TypeDoc
A state represents a condition in a state machine that is the result of the triggers processed.