.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaServer.ProgressEventModel Class Reference

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

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...
 
INodeAccessInfo NodeAccessInfo [get, set]
 Using a NodeAccessInfo can restrict the access of an event to single scopes. 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

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.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.ProgressEventModel.ProgressEventModel ( )
inline

Initializes a new instance of the ProgressEventModel class.

UnifiedAutomation.UaServer.ProgressEventModel.ProgressEventModel ( ProgressEventModel  template)
inline

Initializes a new instance of the ProgressEventModel class.

Parameters
templateThe template.

Member Function Documentation

override void UnifiedAutomation.UaServer.ProgressEventModel.UpdateEvent ( GenericEvent  e)
inlinevirtual

Updates the event.

Parameters
eThe event to update.

Reimplemented from UnifiedAutomation.UaServer.BaseEventModel.

Property Documentation

object UnifiedAutomation.UaServer.ProgressEventModel.Context
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.

ushort UnifiedAutomation.UaServer.ProgressEventModel.Progress
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.


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