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

Contains information about the Node that was changed and the action that occurred to cause the ModelChangeEvent (e.g. add a Node, delete a Node, etc.). More...

Inherits UnifiedAutomation.UaServer.BaseModelChangeEventModel.

Public Member Functions

 GeneralModelChangeEventModel ()
 Initializes a new instance of the GeneralModelChangeEventModel class. More...
 
 GeneralModelChangeEventModel (GeneralModelChangeEventModel template)
 Initializes a new instance of the GeneralModelChangeEventModel class. More...
 
override void UpdateEvent (GenericEvent e)
 Updates the event. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseModelChangeEventModel
 BaseModelChangeEventModel ()
 Initializes a new instance of the BaseModelChangeEventModel class. More...
 
 BaseModelChangeEventModel (BaseModelChangeEventModel template)
 Initializes a new instance of the BaseModelChangeEventModel 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 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

ModelChangeStructureDataType[] Changes [get, set]
 Reflects the changes that issued the ModelChangeEvent. 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

Contains information about the Node that was changed and the action that occurred to cause the ModelChangeEvent (e.g. add a Node, delete a Node, etc.).

If the affected Node is a Variable or object, then the TypeDefinitionNode is also present.

To allow Event compression, a GeneralModelChangeEvent contains an array of changes.

This EventType inherits all Properties of the BaseModelChangeEventType.

Two types of ModelChangeEvents are defined: the BaseModelChangeEvent that does not contain any information about the changes and the GeneralModelChangeEvent that identifies the changed Nodes via an array. The precision used depends on both the capability of the OPC UA Server and the nature of the update. An OPC UA Server may use either ModelChangeEvent type depending on circumstances. It may also define subtypes of these EventTypes adding additional information. To ensure interoperability, one should follow the guidelines for Events listed below.

  • If the array of the GeneralModelChangeEvent is present, then it should identify every Node that has changed since the preceding ModelChangeEvent.
  • The OPC UA Server should emit exactly one ModelChangeEvent for an update or series of updates. It should not issue multiple types of ModelChangeEvent for the same update.
  • Any Client that responds to ModelChangeEvents should respond to any Event of the UnifiedAutomation.UaServer.BaseModelChangeEventModel including its subtypes like the UnifiedAutomation.UaServer.GeneralModelChangeEventModel.

If a Client is not capable of interpreting additional information of the subtypes of the UnifiedAutomation.UaServer.BaseModelChangeEventModel, it should treat Events of these types the same way as Events of the UnifiedAutomation.UaServer.BaseModelChangeEventModel.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.GeneralModelChangeEventModel.GeneralModelChangeEventModel ( )
inline

Initializes a new instance of the GeneralModelChangeEventModel class.

UnifiedAutomation.UaServer.GeneralModelChangeEventModel.GeneralModelChangeEventModel ( GeneralModelChangeEventModel  template)
inline

Initializes a new instance of the GeneralModelChangeEventModel class.

Parameters
templateThe template.

Member Function Documentation

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

Updates the event.

Parameters
eThe event to update.

Reimplemented from UnifiedAutomation.UaServer.BaseModelChangeEventModel.

Property Documentation

ModelChangeStructureDataType [] UnifiedAutomation.UaServer.GeneralModelChangeEventModel.Changes
getset

Reflects the changes that issued the ModelChangeEvent.

It shall contain at least one entry in its array.


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