Used to represent Conditions as dialogs. More...

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

void RaiseConditionChangedEvent (ConditionModel model)

Emits a new condition changed event. More...

virtual StatusCode Enable ()

Changes a Condition instance to the enabled state. More...

virtual StatusCode Enable (RequestContext context)

Changes a Condition instance to the enabled state. More...

virtual StatusCode Disable ()

Changes a Condition instance to the disabled state. More...

virtual StatusCode Disable (RequestContext context)

Changes a Condition instance to the disabled state. More...

virtual StatusCode AddComment (byte[] eventId, LocalizedText comment, string clientUserId)

Applies a comment to a specific state of a Condition instance. More...

virtual StatusCode AddComment (RequestContext context, byte[] eventId, LocalizedText comment)

Applies a comment to a specific state of a Condition instance. More...

virtual void UpdateEnabledEffectiveDisplayName ()

Updates the effect display name for the enabled state. More...

virtual void UpdateRetain ()

Update the retain bit. More...

TransitionRaiser MergeTransitions ()

Merges transitions. More...

TransitionRaiser NewTransition ()

virtual void ActivateModel (RequestContext context)

Activates the model. More...

virtual void DeactivateModel ()

Deactivates the model. 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 SetRolePermissions (RolePermissionTypeCollection rolePermissions, BaseNodeManager nodeManager)

Sets the RolePermissions to an event. Is used to restrict the receiving of the events to certain roles. More...

void SetRolePermissionsAndAccessRestriction (Node sourceNode, BaseNodeManager nodeManager)

Sets the RolePermissions and AccessRestiriction to an event. Is used to restrict the receiving of the events to certain users. More...

void NewId ()

Assigns a new EventId, Time and ReceiveTime to the event. More...

virtual GenericEvent CreateEvent (FilterManager manager)

Creates the event. More...

virtual GenericEvent CreateEvent (FilterManager manager, bool autoGenerateEventIdAndTime)

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...

StatusCode GetStatusCode (string propertyName)

Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned.

Parameters

propertyName The property name.

Returns: The status code of the property.

void SetStatusCode (string propertyName, StatusCode statusCode)

Sets the status code of the given property. More...

Public Member Functions inherited from UnifiedAutomation.UaServer.ICondition

GenericEvent CreateEvent (FilterManager manager, bool autoGenerateEventIdAndTime)

Creates an generic event for the condition. More...

Properties
int	CancelResponse `[get, set]`
	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. More...

int	DefaultResponse `[get, set]`
	Identifies the response option that should be shown as default to the user. More...

TwoStateVariableModel	DialogState `[get, set]`

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

int	LastResponse `[get, set]`
	Contains the last response provided by a Client in the Respond method. More...

int	OkResponse `[get, set]`
	Provides the index of the OK option in the ResponseOptionSet array. More...

LocalizedText	Prompt `[get, set]`
	Prompt is a dialog prompt to be shown to the user. More...

LocalizedText[]	ResponseOptionSet `[get, set]`
	Specifies the desired set of responses as array of LocalizedText. More...

Properties inherited from UnifiedAutomation.UaServer.ConditionModel
bool	IsInitialized `[get, set]`
	Gets or sets if the condition is initialized. More...

uint	TransitionCount `[get]`

NodeId	BranchId `[get, set]`

string	ClientUserId `[get, set]`
	Is related to the Comment field and contains the identity of the user who inserted the most recent Comment. More...

ConditionVariableModel < LocalizedText >	Comment `[get, set]`
	Contains the last comment provided for a certain state (ConditionBranch). More...

new NodeId	ConditionClassId `[get, set]`
	Specifies in which domain this Condition is used. More...

new LocalizedText	ConditionClassName `[get, set]`

string	ConditionName `[get, set]`
	Identifies the Condition instance that the Event originated from. More...

TwoStateVariableModel	EnabledState `[get, set]`
	EnabledState indicates whether the Condition is enabled. More...

ConditionVariableModel< ushort >	LastSeverity `[get, set]`
	Provides the previous severity of the ConditionBranch. More...

ConditionVariableModel < StatusCode >	Quality `[get, set]`
	Reveals the status of process values or other resources that this Condition instance is based upon. More...

bool	Retain `[get, set]`

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

Properties inherited from UnifiedAutomation.UaServer.BaseEventModel
NodeId	NodeId `[get, set]`
	The node identifier for a representation of an event in the Server address space. Used mainly for ConditionIds. More...

byte[]	EventId `[get, set]`
	Generated by the server to uniquely identify a particular Event Notification. More...

NodeId	EventType `[get, set]`
	Describes the specific type of Event. More...

NodeId	SourceNode `[get, set]`
	Identifies the Node that the Event originated from. More...

string	SourceName `[get, set]`
	Provides a description of the source of the Event. More...

DateTime	Time `[get, set]`
	Provides the time the Event occurred. More...

DateTime	ReceiveTime `[get, set]`
	Provides the time the OPC UA Server received the Event from the underlying device of another Server. More...

TimeZoneDataType	LocalTime `[get, set]`
	Contains the Offset and the DaylightSavingInOffset flag. More...

LocalizedText	Message `[get, set]`
	Provides a human-readable and localizable text description of the Event. More...

ushort	Severity `[get, set]`
	An indication of the urgency of the Event. More...

NodeId	ConditionClassId `[get, set]`
	Specifies in which domain this Condition is used. More...

LocalizedText	ConditionClassName `[get, set]`

NodeId	ConditionSubClassId `[get, set]`
	ConditionSubClassId specifies additional class[es] that apply to the Event. More...

LocalizedText	ConditionSubClassName `[get, set]`

INodeAccessInfo	NodeAccessInfo `[get, set]`
	Using a NodeAccessInfo can restrict the access of an event to single scopes. More...

AccessRestrictionType	AccessRestriction `[get, set]`
	Using the AcccessRestrictions accessing the events can be restricted for users having a secure connection. More...

IRolePermissions	RolePermissions `[get, set]`
	Using the RolePermissions accessing the events can be restricted for users having one of the configured roles. 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...

Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool	HasStatusCodes `[get]`
	`true` if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...

Properties inherited from UnifiedAutomation.UaServer.ICondition
bool	Retain `[get]`
	The retain state. See Part 9: Alarms and Conditions More...

NodeId	SourceNode `[get]`
	The source node. See Part 9: Alarms and Conditions More...

Additional Inherited Members
Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool	HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0

Protected Member Functions inherited from UnifiedAutomation.UaServer.ConditionModel
void	RaiseTransition ()
	Ends a merged transitions. More...

virtual void	Initialize ()
	Called when the model is activated for the first time. More...

Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
void	RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null)
	Raises an property change event. More...

void	RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null)
	Called when the value of a property is supposed to be changed. More...

bool	SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null)
	Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...

Events inherited from UnifiedAutomation.UaServer.ConditionModel
EventHandler< ConditionModel >	ConditionChanged
	Occurs when the condition changed in a way that a new UA event needs to be emitted. More...

Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler	PropertyChanged
	Occurs when a property value changes. More...

EventHandler < PropertyChangeRequestedEventArgs >	PropertyChangeRequested
	The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...

EventHandler < StatusCodeChangedEventArgs >	StatusCodeChanged

Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler < PropertyChangeRequestedEventArgs >	PropertyChangeRequested
	The property change request event. More...

Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler < StatusCodeChangedEventArgs >	StatusCodeChanged
	Occurs if the status code of a property was changed. More...

Detailed Description

Used to represent Conditions as dialogs.

The DialogConditionType inherits all Properties of the ConditionType.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.DialogConditionModel.DialogConditionModel ( )

Initializes a new instance of the DialogConditionModel class.

UnifiedAutomation.UaServer.DialogConditionModel.DialogConditionModel ( DialogConditionModel template )

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
	)

virtual

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
	)

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 )

virtual

Updates the event.

Parameters

e	The event to update.

Reimplemented from UnifiedAutomation.UaServer.ConditionModel.

Property Documentation

int UnifiedAutomation.UaServer.DialogConditionModel.CancelResponse

getset

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

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

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

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

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

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

LocalizedText [] UnifiedAutomation.UaServer.DialogConditionModel.ResponseOptionSet

getset

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:

D:/work/uasdknet_master/src/UaServer/Models/UaBaseClasses.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation