StateMachineTemplate.CreateStateConfiguration Method (String[])

StateMachineTemplateCreateStateConfiguration Method (String)

Creates a new StateConfiguration instance from a list of state names.

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

Syntax

C++

Copy

public StateConfiguration CreateStateConfiguration(
	string[] stateBaseConfiguration
)

Public Function CreateStateConfiguration ( 
	stateBaseConfiguration As String()
) As StateConfiguration

public:
StateConfiguration^ CreateStateConfiguration(
	array<String^>^ stateBaseConfiguration
)

member CreateStateConfiguration : 
        stateBaseConfiguration : string[] -> StateConfiguration

Parameters

stateBaseConfiguration: Type: SystemString
A list of String that reference State instances within this StateMachineTemplate.

Return Value

Type: StateConfiguration
A StateConfiguration instance.

Exceptions

Exception	Condition
ArgumentNullException	The stateBaseConfiguration is null.
InvalidOperationException	A StateConfiguration instance cannot be created when the StateMachineTemplate is not complete. The Root property is not initialized to a valid Region instance.
ArgumentOutOfRangeException	At least one of the State instances provided through stateBaseConfiguration could not be found.
ArgumentOutOfRangeException	The State instances provided through stateBaseConfiguration contain mutually exclusive State instances, e.g. State instances from the same Region instance.

Remarks

The State instances referenced through stateBaseConfiguration must be part of disjoint orthogonal sub-regions.

In absence of orthogonal sub-regions, a StateConfiguration is sufficiently defined through a single state. Passing in the parent states of the single state will not further improve or change the StateConfiguration.

Reference

StateMachineTemplate Class

CreateStateConfiguration Overload

StaMa Namespace