Click or drag to resize
StaMaStateMachineTemplate Class
Contains the structure and behaviour definition of a state machine.
Inheritance Hierarchy
SystemObject
  StaMaStateMachineTemplate

Namespace: StaMa
Assembly: StaMa (in StaMa.dll) Version: 2.3.1.7
Syntax
Copy
public class StateMachineTemplate

The StateMachineTemplate type exposes the following members.

Constructors
  NameDescription
Public methodStateMachineTemplate
Initializes a new instance of the StateMachineTemplate class.
Public methodStateMachineTemplate(StateMachineOptions)
Initializes a new instance of the StateMachineTemplate class with specific options.
Top
Properties
  NameDescription
Public propertyConcurrencyDegree
Gets the maximum number of concurrent transitions possible for a single trigger event.
Public propertyHistoryMax
Gets the number of history storage slots necessary within a StateMachine instance.
Public propertyRoot
Gets the root Region instance of this StateMachineTemplate instance.
Public propertySerializationSignatureGenerator
Gets or sets a method that calculates a hash signature from a String that uniquely describes the state machine structure.
Public propertySignature
Gets a hash signature for the state machine structure.
Public propertyStateConfigurationMax
Gets the length of the state array within a StateConfiguration instance.
Public propertyStateMachineOptions
Gets the option flags for the state machine.
Top
Methods
  NameDescription
Public methodCreateStateConfiguration(String)
Creates a new StateConfiguration instance from a state name.
Public methodCreateStateConfiguration(String)
Creates a new StateConfiguration instance from a list of state names.
Public methodCreateStateMachine
Creates a StateMachine instance from the StateMachineTemplate.
Public methodCreateStateMachine(Object)
Creates a StateMachine instance from the StateMachineTemplate.
Public methodEndRegion
Completes the definition of a Region's States.
Public methodEndState
Completes the definition of a State's substructure and contents.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberIsValidIdentifier
Checks whether the given name is a valid identifier or a cardinal number.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodPassThrough
Provides the accept method of a visitor pattern that traverses the Region, State and Transition instances of this StateMachineTemplate.
Public methodRegion
Creates a Region instance and precedes the definition of the Region's States.
Public methodState(String)
Creates a State instance and starts the definition the State's substructure and contents.
Public methodState(String, StateMachineActionCallback, StateMachineActionCallback)
Creates a State instance and starts the definition the State's substructure and contents.
Public methodState(String, StateMachineActionCallback, StateMachineActionCallback, StateMachineDoActionCallback)
Creates a State instance and starts the definition the State's substructure and contents.
Public methodToString (Inherited from Object.)
Public methodTransition(String, String, Object)
Creates a Transition that starts at the State defined by the enclosing StateMachineTemplate.State Overload...EndState statements.
Public methodTransition(String, String, Object)
Creates a fork Transition that starts at the State defined by the enclosing StateMachineTemplate.State Overload...EndState statements.
Public methodTransition(String, String, String, Object)
Creates a Transition from the State defined by the enclosing StateMachineTemplate.State Overload ... EndState statements.
Public methodTransition(String, String, String, Object)
Defines a transition emanating from state defined through the enclosing State(String)...EndState calls.
Public methodTransition(String, String, String, Object)
Defines a transition emanating from state defined through the enclosing State(String)...EndState calls.
Public methodTransition(String, String, String, Object)
Defines a transition emanating from state defined through the enclosing State(String)...EndState calls.
Public methodTransition(String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)
Creates a Transition that starts at the State defined by the enclosing StateMachineTemplate.State Overload...EndState statements.
Public methodTransition(String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)
Creates a Transition that starts at the State defined by the enclosing StateMachineTemplate.State Overload...EndState statements.
Public methodTransition(String, String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)
Defines a transition emanating from state defined through the enclosing State(String)...EndState calls.
Public methodTransition(String, String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)
Defines a transition emanating from state defined through the enclosing State(String)...EndState calls.
Public methodTransition(String, String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)
Defines a transition emanating from state defined through the enclosing State(String)...EndState calls.
Public methodTransition(String, String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)
Defines a transition emanating from state defined through the enclosing State(String)...EndState calls.
Top
Remarks
StateMachine instances with identical behaviour may be created from an instance of this class through the CreateStateMachine method. The StateMachine instances interpret the structure definition in the StateMachineTemplate instance during trigger event dispatching and accordingly execute state entry and exit callbacks.
See Also