5.6.2 DialogConditionType

The DialogConditionType is used to represent Conditions as dialogs. It is illustrated in Figure 12 and formally defined in Table 24 and Table 25.

Figure 12 – DialogConditionType Overview
Table 24 – DialogConditionType definition
Attribute Value
BrowseNameDialogConditionType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Modelling
Rule
Subtype of the ConditionType defined in clause 5.5.2
HasComponentVariableDialogStateLocalizedTextTwoStateVariableTypeMandatory
HasPropertyVariablePromptLocalizedTextPropertyTypeMandatory
HasPropertyVariableResponseOptionSetLocalizedText [ ]PropertyTypeMandatory
HasPropertyVariableDefaultResponseInt32PropertyTypeMandatory
HasPropertyVariableLastResponseInt32PropertyTypeMandatory
HasPropertyVariableOkResponseInt32PropertyTypeMandatory
HasPropertyVariableCancelResponseInt32PropertyTypeMandatory
HasComponentMethodRespondDefined in Clause 5.6.3.Mandatory
HasComponentMethodRespond2Defined in Clause 5.6.4.Optional
ConformanceUnits
A & C Dialog
Table 25 – DialogConditionType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
DialogStateHasPropertyVariableTrueStateLocalizedTextPropertyType
DialogStateHasPropertyVariableFalseStateLocalizedTextPropertyType

The empty “Others” column indicates that no ModellingRule applies.

The DialogConditionType inherits all Properties of the ConditionType.

DialogState/Id when set to True indicates that the Dialog is active and waiting for a response. Recommended state names are described in A.2.

Prompt is a dialog prompt to be shown to the user.

ResponseOptionSet specifies the desired set of responses as array of LocalizedText. The index in this array is used for the corresponding fields like DefaultResponse, LastResponse and SelectedOption in the Respond Method. The recommended localized names for the common options are described in A.1.

Typical combinations of response options are

DefaultResponse identifies the response option that should be shown as default to the user. It is the index in the ResponseOptionSet array. If no response option is the default, the value of the Property is -1.

LastResponse contains the last response provided by a Client in the Respond Method. If no previous response exists, then the value of the Property is -1.

OkResponse provides the index of the OK option in the ResponseOptionSet array. This choice is the response that will allow the system to proceed with the operation described by the prompt. This allows a Client to identify the OK option if a special handling for this option is available. If no OK option is available, the value of this Property is -1.

CancelResponse provides the index of the response in the ResponseOptionSet array that will cause the Dialog to go into the inactive state without proceeding with the operation described by the prompt. This allows a Client to identify the Cancel option if a special handling for this option is available. If no Cancel option is available, the value of this Property is -1.