.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaServer.GenericEvent Class Reference

A class that stores the fields for an event fired by the server application. More...

Public Member Functions

 GenericEvent (FilterManager manager)
 Initializes a new instance of the GenericEvent class. More...
 
void Initialize (byte[] eventId, ExpandedNodeId eventType, NodeId sourceNode, string sourceName, EventSeverity severity, LocalizedText message)
 Initializes the event. More...
 
void Initialize (byte[] eventId, ExpandedNodeId eventType, EventSeverity severity, LocalizedText message, ObjectNode sourceNode, BaseNodeManager nodeManager)
 Initializes the event using the source node of the event. More...
 
void Set (int handle, IEncodeable value)
 Sets the value for the event field with the specified handle. More...
 
void Set (int handle, Variant value)
 Sets the value for the event field with the specified handle. More...
 
void Set (string browsePath, IEncodeable value)
 Sets the value for the event field with the specified browse path. More...
 
void Set (string browsePath, Variant value)
 Sets the value for the event field with the specified browse path. More...
 
string ToPath (params AbsoluteName[] browseNames)
 Converts the browse names to a browse path. More...
 
string ToPath (params QualifiedName[] browseNames)
 Converts the browse names to a browse path. More...
 
string ToPath (params string[] browseNames)
 Converts the browse names to a browse path. More...
 
Variant Get (params AbsoluteName[] browseNames)
 Gets the field value for the browse path. More...
 
Variant Get (params QualifiedName[] browseNames)
 Gets the field value for the browse path. More...
 
Variant Get (params string[] browseNames)
 Gets the field value for the browse path. More...
 
Variant Get (int handle)
 Gets the field value for the handle More...
 
Variant Get (SimpleAttributeOperand clause)
 Gets the field value for the operand. 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. The server must be running when this method is called. 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. The server must be running when this method is called. More...
 

Properties

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...
 
DateTime Time [get, set]
 Provides the time the Event occurred. More...
 
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...
 
FilterManager Manager [get]
 Gets the manager. More...
 

Detailed Description

A class that stores the fields for an event fired by the server application.

This interface is used to pass an event to ServerManager.ReportEvent for distribution to interested clients.

The class BaseEventModel provides the method UpdateEvent, setting all event fields at a GenericEvent which are defined by an EventType.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.GenericEvent.GenericEvent ( FilterManager  manager)

Initializes a new instance of the GenericEvent class.

Parameters
managerThe manager.

Member Function Documentation

Variant UnifiedAutomation.UaServer.GenericEvent.Get ( params AbsoluteName[]  browseNames)

Gets the field value for the browse path.

Parameters
browseNamesThe browse names.
Returns
Variant UnifiedAutomation.UaServer.GenericEvent.Get ( params QualifiedName[]  browseNames)

Gets the field value for the browse path.

Parameters
browseNamesThe browse names.
Returns
Variant UnifiedAutomation.UaServer.GenericEvent.Get ( params string[]  browseNames)

Gets the field value for the browse path.

Parameters
browseNamesThe browse names.
Returns
Variant UnifiedAutomation.UaServer.GenericEvent.Get ( int  handle)

Gets the field value for the handle

Parameters
handleThe handle.
Returns
Variant UnifiedAutomation.UaServer.GenericEvent.Get ( SimpleAttributeOperand  clause)

Gets the field value for the operand.

Parameters
clauseThe clause.
Returns
void UnifiedAutomation.UaServer.GenericEvent.Initialize ( byte[]  eventId,
ExpandedNodeId  eventType,
NodeId  sourceNode,
string  sourceName,
EventSeverity  severity,
LocalizedText  message 
)

Initializes the event.

Parameters
eventIdThe event id.
eventTypeType of the event.
sourceNodeThe source node.
sourceNameName of the source.
severityThe severity.
messageThe message.
void UnifiedAutomation.UaServer.GenericEvent.Initialize ( byte[]  eventId,
ExpandedNodeId  eventType,
EventSeverity  severity,
LocalizedText  message,
ObjectNode  sourceNode,
BaseNodeManager  nodeManager 
)

Initializes the event using the source node of the event.

Parameters
eventIdThe unique event id.
eventTypeType of the event.
severityThe severity.
messageThe message.
sourceNodeThe source node of the event. Must not be null.
nodeManagerThe BaseNodeManager managing the namespace of the source node.
void UnifiedAutomation.UaServer.GenericEvent.Set ( int  handle,
IEncodeable  value 
)

Sets the value for the event field with the specified handle.

Parameters
handleThe handle.
valueThe value.
void UnifiedAutomation.UaServer.GenericEvent.Set ( int  handle,
Variant  value 
)

Sets the value for the event field with the specified handle.

Parameters
handleThe handle.
valueThe value.
void UnifiedAutomation.UaServer.GenericEvent.Set ( string  browsePath,
IEncodeable  value 
)

Sets the value for the event field with the specified browse path.

Parameters
browsePathThe browse path.
valueThe value.
void UnifiedAutomation.UaServer.GenericEvent.Set ( string  browsePath,
Variant  value 
)

Sets the value for the event field with the specified browse path.

Parameters
browsePathThe browse path.
valueThe value.
void UnifiedAutomation.UaServer.GenericEvent.SetRolePermissions ( RolePermissionTypeCollection  rolePermissions,
BaseNodeManager  nodeManager 
)

Sets the RolePermissions to an event. Is used to restrict the receiving of the events to certain roles. The server must be running when this method is called.

Parameters
rolePermissionsThe RolePermissions to be set. If null, the namespace default is set. Must not be null.
nodeManagerThe BaseNodeManager that manages the SourceNode. Must not be null.
void UnifiedAutomation.UaServer.GenericEvent.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. The server must be running when this method is called.

Parameters
sourceNodeThe RolePermissions and the AccessRestrictions of this node are used. If not set, the namespace default is set. Must not be null.
nodeManagerThe BaseNodeManager that manages the sourceNode. Must not be null.
string UnifiedAutomation.UaServer.GenericEvent.ToPath ( params AbsoluteName[]  browseNames)

Converts the browse names to a browse path.

Parameters
browseNamesThe browse names.
Returns
string UnifiedAutomation.UaServer.GenericEvent.ToPath ( params QualifiedName[]  browseNames)

Converts the browse names to a browse path.

Parameters
browseNamesThe browse names.
Returns
string UnifiedAutomation.UaServer.GenericEvent.ToPath ( params string[]  browseNames)

Converts the browse names to a browse path.

Parameters
browseNamesThe browse names.
Returns

Property Documentation

AccessRestrictionType UnifiedAutomation.UaServer.GenericEvent.AccessRestriction
getset

Using the AcccessRestrictions accessing the events can be restricted for users having a secure connection.

byte [] UnifiedAutomation.UaServer.GenericEvent.EventId
getset

Generated by the server to uniquely identify a particular Event Notification.

The Server is responsible to ensure that each Event has its unique EventId. It may do this, for example, by putting GUIDs into the ByteString. Clients can use the EventId to assist in minimizing or eliminating gaps and overlaps that may occur during a redundancy fail over. The EventId shall always be returned as value and the Server is not allowed to return a StatusCode for the EventId indicating an error.

NodeId UnifiedAutomation.UaServer.GenericEvent.EventType
getset

Describes the specific type of Event.

The EventType shall always be returned as value and the Server is not allowed to return a StatusCode for the EventType indicating an error.

FilterManager UnifiedAutomation.UaServer.GenericEvent.Manager
get

Gets the manager.

The manager.

INodeAccessInfo UnifiedAutomation.UaServer.GenericEvent.NodeAccessInfo
getset

Using a NodeAccessInfo can restrict the access of an event to single scopes.

IRolePermissions UnifiedAutomation.UaServer.GenericEvent.RolePermissions
getset

Using the RolePermissions accessing the events can be restricted for users having one of the configured roles.

NodeId UnifiedAutomation.UaServer.GenericEvent.SourceNode
getset

Identifies the Node that the Event originated from.

If the Event is not specific to a Node, the NodeId is set to null. Some subtypes of this BaseEventType may define additional rules for SourceNode.

DateTime UnifiedAutomation.UaServer.GenericEvent.Time
getset

Provides the time the Event occurred.

This value is set as close to the event generator as possible. It often comes from the underlying system or device. Once set, intermediate OPC UA Servers shall not alter the value.


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