StateMachineTemplate.Transition Method (String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)

StateMachineTemplateTransition Method (String, String, Object, StateMachineGuardCallback, StateMachineActionCallback)

Creates a Transition that starts at the State defined by the enclosing StateMachineTemplate.State Overload...EndState statements.

Namespace: StaMa
Assembly: StaMa (in StaMa.dll) Version: 2.3.1.7

Syntax

C++

Copy

public void Transition(
	string name,
	string targetState,
	Object triggerEvent,
	StateMachineGuardCallback guard,
	StateMachineActionCallback transitionAction
)

Public Sub Transition ( 
	name As String,
	targetState As String,
	triggerEvent As Object,
	guard As StateMachineGuardCallback,
	transitionAction As StateMachineActionCallback
)

public:
void Transition(
	String^ name, 
	String^ targetState, 
	Object^ triggerEvent, 
	StateMachineGuardCallback^ guard, 
	StateMachineActionCallback^ transitionAction
)

member Transition : 
        name : string * 
        targetState : string * 
        triggerEvent : Object * 
        guard : StateMachineGuardCallback * 
        transitionAction : StateMachineActionCallback -> unit

Parameters

name: Type: SystemString
A name that identifies the Transition for debugging and tracing purposes. Must be unique within the StateMachineTemplate.
targetState: Type: SystemString
The name of a State instance that defines the target-State of the Transition.
triggerEvent: Type: SystemObject
A Object that represents the trigger event that will execute the transition or null to indicate an "any" transition. See also SendTriggerEvent(Object).
guard: Type: StaMaStateMachineGuardCallback
A StateMachineGuardCallback delegate that provides additional conditions for the transition; otherwise, null if no addititional conditions are neccessary.
transitionAction: Type: StaMaStateMachineActionCallback
A StateMachineActionCallback delegate that will be called when the transition is executed. May be null if no transition action is required.

Exceptions

Exception	Condition
ArgumentNullException	The name is null or empty.
ArgumentOutOfRangeException	The name is not a valid identifier for a Transition: The identifier of a Transition must start with a character followed by nonspace characters or digits.
ArgumentOutOfRangeException	The name is not a unique: A Transition with the same name already exists within the StateMachineTemplate instance.
StateMachineException	A syntax error was detected with this or the preceeding Region, EndRegion, State, EndState or Transition statements.

Remarks

The targetState may reference any State within this StateMachineTemplate.

Reference

StateMachineTemplate Class

Transition Overload

StaMa Namespace