 | StateMachine Class |
Contains the active state of a state machine. Receives the trigger events and
executes the actions according to the state machine structure defined by the StateMachineTemplate from which the StateMachine instance is created.
Inheritance HierarchyNamespace: StaMa
Assembly: StaMa (in StaMa.dll) Version: 2.3.1.7
SyntaxThe StateMachine type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActiveStateConfiguration |
Gets the active state of the StateMachine instance.
|
| Context |
Gets additional client provided context information.
|
| Template |
Gets the StateMachineTemplate instance that defines the structure for this StateMachine.
|
| TraceDispatchTriggerEvent |
Gets or sets a callback that can be used for tracing the StateMachine operation.
|
| TraceStateChange |
Gets or sets a callback that can be used for tracing state changes in the StateMachine.
|
| TraceTestTransition |
Gets or sets a callback that can be used for tracing and analyzing the StateMachine operation.
|
Methods| Name | Description | |
|---|---|---|
 | ClearEventQueue |
Discards any pending events in the event queue of the StateMachine.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| Finish |
Finalizes the StateMachine by executing the
exit actions of all active states.
|
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| IsInState |
Returns whether the StateMachine resides in the
given StateConfiguration.
|
| MemberwiseClone | (Inherited from Object.) |
 | Resume |
Initializes the ActiveStateConfiguration and history settings from a Stream and resumes state machine execution with the stored state.
|
| SaveState |
Saves the state machine active state and history to a Stream that may be used to resume with this state later e.g. after the hosting process has been restarted.
|
| SendTriggerEvent(Object) |
Enqueues a trigger event and starts processing the state machine, if not already inside a processing.
As a result a transition may be executed by invoking exit actions, changing the active state and invoking entry actions.
|
| SendTriggerEvent(Object, EventArgs) |
Enqueues a trigger event together with additional parameters and starts processing the state machine, if not already inside a processing.
As a result a transition may be executed by invoking exit actions, changing the active state and invoking entry actions.
|
| SetContext |
Sets the context in case it is not available before construction of the StateMachine
instance.
|
| Startup |
Brings the StateMachine in the initial state by invoking the entry actions
of the initial states. Resets the event queue and initializes the history.
|
| ToString |
Returns the human readable representation of the active state StateConfiguration of this StateMachine.
(Overrides ObjectToString.) |
Remarks
Instances of this class are created through the CreateStateMachine method.
See Also