 |
.NET Based OPC UA Client/Server SDK
3.3.0.530
|
|
.NET Based OPC UA Client/Server SDK
3.3.0.530
|
Generated to identify the progress of an operation. More...
Inherits UnifiedAutomation.UaServer.BaseEventModel.
Public Member Functions | |||
| ProgressEventModel () | |||
| Initializes a new instance of the ProgressEventModel class. More... | |||
| ProgressEventModel (ProgressEventModel template) | |||
| Initializes a new instance of the ProgressEventModel class. More... | |||
| override void | UpdateEvent (GenericEvent e) | ||
| Updates the event. 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.
| |||
| void | SetStatusCode (string propertyName, StatusCode statusCode) | ||
| Sets the status code of the given property. More... | |||
Properties | |
| object | Context [get, set] |
| Contains context information about what operation progress is reported. More... | |
| ushort | Progress [get, set] |
| Contains the percentage completed of the progress. 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... | |
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.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.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... | |
Generated to identify the progress of an operation.
An operation can be a Service call or something application specific like a program execution. This EventType inherits all Properties of the BaseEventType. The SourceNode for Events of this type shall be assigned to the NodeId of the Session object where the operation was initiated. The SourceName for Events of this type shall be “Service/[Service Name as defined in Part 4 of the OPC UA Specification]” when the progress of a Service call is exposed.
It is recommended that Servers only expose ProgressEvents for Service calls to the Session that invoked the Service.
| UnifiedAutomation.UaServer.ProgressEventModel.ProgressEventModel | ( | ) |
Initializes a new instance of the ProgressEventModel class.
| UnifiedAutomation.UaServer.ProgressEventModel.ProgressEventModel | ( | ProgressEventModel | template | ) |
Initializes a new instance of the ProgressEventModel class.
| template | The template. |
|
virtual |
Updates the event.
| e | The event to update. |
Reimplemented from UnifiedAutomation.UaServer.BaseEventModel.
|
getset |
Contains context information about what operation progress is reported.
In the case of Service calls it shall be a UInt32 containing the requestHandle of the RequestHeader of the Service call.
|
getset |
Contains the percentage completed of the progress.
The value shall be between 0 and 100, where 100 identifies that the operation has been finished.