Inherits UnifiedAutomation.UaServer.ConditionModel, and UnifiedAutomation.UaServer.IMethodDispatcher.

Public Member Functions
	DialogConditionModel ()
	Initializes a new instance of the DialogConditionModel class. More...

	DialogConditionModel (DialogConditionModel template)
	Initializes a new instance of the DialogConditionModel class. More...

override void	UpdateEvent (GenericEvent e)
	Updates the event. More...

override CallMethodEventHandler	GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId)
	Gets the method dispatcher. More...

override StatusCode	DispatchMethod (RequestContext context, MethodHandle methodHandle, IList< Variant > inputArguments, List< StatusCode > inputArgumentResults, List< Variant > outputArguments)
	Dispatches the method. More...

Public Member Functions inherited from UnifiedAutomation.UaServer.ConditionModel
virtual StatusCode	Enable (RequestContext context)
	Enables the condition. More...

virtual StatusCode	Disable (RequestContext context)
	Disables the condition. More...

virtual StatusCode	AddComment (RequestContext context, byte[] eventId, LocalizedText comment)
	Adds a comment to the condition. More...

virtual void	UpdateEnabledEffectiveDisplayName ()
	Updates the effect display name for the enabled state. More...

	ConditionModel ()
	Initializes a new instance of the ConditionModel class. More...

	ConditionModel (ConditionModel template)
	Initializes a new instance of the ConditionModel class. More...

Public Member Functions inherited from UnifiedAutomation.UaServer.BaseEventModel
	BaseEventModel ()
	Initializes a new instance of the BaseEventModel class. More...

	BaseEventModel (BaseEventModel template)
	Initializes a new instance of the BaseEventModel class. More...

void	NewId ()
	Assigns a new event id, time and receive time to the event. More...

virtual GenericEvent	CreateEvent (FilterManager manager)
	Creates the event. More...

Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
virtual ModelHandle	GetModelHandle (StringTable namespaceUris, object instance)
	Gets the metadata handle. More...

virtual DataValue	GetValue (IMapperContext context, ModelMapping mapping)
	Gets the value associated with the mapping. More...

virtual bool	SetValue (IMapperContext context, ModelMapping mapping, DataValue value)
	Sets the value associated with the mapping. More...

Properties
int	CancelResponse `[get, set]`
	Gets or sets the CancelResponse More...

int	DefaultResponse `[get, set]`
	Gets or sets the DefaultResponse More...

TwoStateVariableModel	DialogState `[get, set]`
	Gets or sets the DialogState More...

new TwoStateVariableModel	EnabledState `[get, set]`
	Gets or sets the EnabledState More...

int	LastResponse `[get, set]`
	Gets or sets the LastResponse More...

int	OkResponse `[get, set]`
	Gets or sets the OkResponse More...

LocalizedText	Prompt `[get, set]`
	Gets or sets the Prompt More...

LocalizedText[]	ResponseOptionSet `[get, set]`
	Gets or sets the ResponseOptionSet More...

Properties inherited from UnifiedAutomation.UaServer.ConditionModel
NodeId	BranchId `[get, set]`
	Gets or sets the BranchId More...

string	ClientUserId `[get, set]`
	Gets or sets the ClientUserId More...

ConditionVariableModel < LocalizedText >	Comment `[get, set]`
	Gets or sets the Comment More...

NodeId	ConditionClassId `[get, set]`
	Gets or sets the ConditionClassId More...

LocalizedText	ConditionClassName `[get, set]`
	Gets or sets the ConditionClassName More...

string	ConditionName `[get, set]`
	Gets or sets the ConditionName More...

TwoStateVariableModel	EnabledState `[get, set]`
	Gets or sets the EnabledState More...

ConditionVariableModel< ushort >	LastSeverity `[get, set]`
	Gets or sets the LastSeverity More...

ConditionVariableModel < StatusCode >	Quality `[get, set]`
	Gets or sets the Quality More...

bool	Retain `[get, set]`
	Gets or sets the Retain More...

IConditionMethods	ConditionMethods `[get, set]`
	Gets or sets the Condition methods. More...

Properties inherited from UnifiedAutomation.UaServer.BaseEventModel
NodeId	NodeId `[get, set]`
	Gets or sets the event id. More...

byte[]	EventId `[get, set]`
	Gets or sets the event id. More...

NodeId	EventType `[get, set]`
	Gets or sets the type of the event. More...

NodeId	SourceNode `[get, set]`
	Gets or sets the source node. More...

string	SourceName `[get, set]`
	Gets or sets the name of the source. More...

DateTime	Time `[get, set]`
	Gets or sets the time. More...

DateTime	ReceiveTime `[get, set]`
	Gets or sets the receive time. More...

TimeZoneDataType	LocalTime `[get, set]`
	Gets or sets the local time. More...

LocalizedText	Message `[get, set]`
	Gets or sets the message. More...

ushort	Severity `[get, set]`
	Gets or sets the severity. More...

Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle	ModelHandle `[get, set]`
	Gets or sets the metadata handle. More...

object	UserData `[get, set]`
	Gets or sets the user data. More...

Detailed Description

The DialogConditionType is used to represent Conditions as dialogs. The DialogConditionType inherits all Properties of the ConditionType.

DialogState when set to TRUE indicates that the Dialog is active and waiting for a response. See UnifiedAutomation.UaServer.DialogConditionModel.DialogState for more details.

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

ResponseOptionSet specifies the desired set of responses as array of LocalizedText. See UnifiedAutomation.UaServer.DialogConditionModel.ResponseOptionSet for more details.

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. See UnifiedAutomation.UaServer.DialogConditionModel.OkResponse for more details.

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. See UnifiedAutomation.UaServer.DialogConditionModel.CancelResponse for more details.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.DialogConditionModel.DialogConditionModel ( )

inline

Initializes a new instance of the DialogConditionModel class.

UnifiedAutomation.UaServer.DialogConditionModel.DialogConditionModel ( DialogConditionModel template )

inline

Initializes a new instance of the DialogConditionModel class.

Parameters

template The template.

Member Function Documentation

override StatusCode UnifiedAutomation.UaServer.DialogConditionModel.DispatchMethod	(	RequestContext	context,
		MethodHandle	methodHandle,
		IList< Variant >	inputArguments,
		List< StatusCode >	inputArgumentResults,
		List< Variant >	outputArguments
	)

inlinevirtual

Dispatches the method.

Parameters

context	The context.
methodHandle	The method handle.
inputArguments	The input arguments.
inputArgumentResults	The input argument results.
outputArguments	The output arguments.

Returns

Reimplemented from UnifiedAutomation.UaServer.ConditionModel.

override CallMethodEventHandler UnifiedAutomation.UaServer.DialogConditionModel.GetMethodDispatcher	(	RequestContext	context,
		NodeId	objectId,
		NodeId	methodId
	)

inline

Gets the method dispatcher.

Parameters

context	The context.
objectId	The object id.
methodId	The method id.

Returns

Implements UnifiedAutomation.UaServer.IMethodDispatcher.

override void UnifiedAutomation.UaServer.DialogConditionModel.UpdateEvent ( GenericEvent e )

inlinevirtual

Updates the event.

Parameters

e	The event to update.

Reimplemented from UnifiedAutomation.UaServer.ConditionModel.

Property Documentation

int UnifiedAutomation.UaServer.DialogConditionModel.CancelResponse

getset

Gets or sets the CancelResponse

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.

int UnifiedAutomation.UaServer.DialogConditionModel.DefaultResponse

getset

Gets or sets the DefaultResponse

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.

TwoStateVariableModel UnifiedAutomation.UaServer.DialogConditionModel.DialogState

getset

Gets or sets the DialogState

DialogState when set to TRUE indicates that the Dialog is active and waiting for a response. Recommended state names for LocaleIds are listed in the following table.

LocaleId	FALSE State Name	TRUE State Name
en	Inactive	Active
de	Inaktiv	Aktiv
fr	Inactive	Active

new TwoStateVariableModel UnifiedAutomation.UaServer.DialogConditionModel.EnabledState

getset

Gets or sets the EnabledState

int UnifiedAutomation.UaServer.DialogConditionModel.LastResponse

getset

Gets or sets the LastResponse

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

int UnifiedAutomation.UaServer.DialogConditionModel.OkResponse

getset

Gets or sets the OkResponse

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.

LocalizedText UnifiedAutomation.UaServer.DialogConditionModel.Prompt

getset

Gets or sets the Prompt

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

LocalizedText [] UnifiedAutomation.UaServer.DialogConditionModel.ResponseOptionSet

getset

Gets or sets the ResponseOptionSet

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 Dialog response option names in different locales are listed in the following table.

Locale “en”	Locale “de”
Ok	OK
Cancel	Abbrechen
Yes	Ja
No	Nein
Abort	Abbrechen
Retry	Wiederholen
Ignore	Ignorieren
Next	Nächster
Previous	Vorheriger

Typical combinations of response options are

OK
OK, Cancel
Yes, No, Cancel
Abort, Retry, Ignore
Retry, Cancel
Yes, No

The documentation for this class was generated from the following file:

C:/work/uasdknet/src/UaServer/Models/UaBaseClasses.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation