.NET Based OPC UA Client/Server SDK  3.0.10.493
UnifiedAutomation.UaBase.CreateMonitoredItemsRequest Class Reference

Asynchronous call to create a list of monitored items in the subscription. More...

Inherits UnifiedAutomation.UaBase.IServiceRequest, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 CreateMonitoredItemsRequest ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 

Properties

RequestHeader RequestHeader [get, set]
 
uint SubscriptionId [get, set]
 The Server-assigned identifier for the Subscription that will report Notifications for this MonitoredItem. More...
 
TimestampsToReturn TimestampsToReturn [get, set]
 An enumeration that specifies the timestamp Attributes to be transmitted for each MonitoredItem. More...
 
MonitoredItemCreateRequestCollection ItemsToCreate [get, set]
 A list of MonitoredItems to be created and assigned to the specified Subscription. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
- Properties inherited from UnifiedAutomation.UaBase.IServiceRequest
RequestHeader RequestHeader [get, set]
 The header for the request. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

Asynchronous call to create a list of monitored items in the subscription.

This service is used to create and add one or more MonitoredItems to a Subscription. A MonitoredItem is deleted automatically by the Server when the Subscription is deleted. Deleting a MonitoredItem causes its entire set of triggered item links to be deleted, but has no effect on the MonitoredItems referenced by the triggered items.

Calling the CreateMonitoredItems service repetitively to add a small number of MonitoredItems each time may adversely affect the performance of the Server. Instead, Clients should add a complete set of MonitoredItems to a Subscription whenever possible.

When a user adds a monitored item that the user is denied read access to, the add operation for the item shall succeed and the bad status Bad_NotReadable or Bad_UserAccessDenied shall be returned in the Publish response. This is the same behaviour for the case where the access rights are changed after the call to CreateMonitoredItems. If the access rights change to read rights, the Server shall start sending data for the MonitoredItem. The same procedure shall be applied for an IndexRange that does not deliver data for the current value but could deliver data in the future.

Monitored Nodes can be removed from the AddressSpace after the creation of a MonitoredItem. This does not affect the validity of the MonitoredItem but a Bad_NodeIdUnknown shall be returned in the Publish response.

The return diagnostic info setting in the request header of the CreateMonitoredItems or the last ModifyMonitoredItems Service is applied to the Monitored Items and is used as the diagnostic information settings when sending notifications in the Publish response.

Illegal request values for parameters that can be revised do not generate errors. Instead, the server will choose default values and indicate them in the corresponding revised parameter.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.CreateMonitoredItemsRequest.CreateMonitoredItemsRequest ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.CreateMonitoredItemsRequest.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

Property Documentation

MonitoredItemCreateRequestCollection UnifiedAutomation.UaBase.CreateMonitoredItemsRequest.ItemsToCreate
getset

A list of MonitoredItems to be created and assigned to the specified Subscription.

RequestHeader UnifiedAutomation.UaBase.CreateMonitoredItemsRequest.RequestHeader
getset

uint UnifiedAutomation.UaBase.CreateMonitoredItemsRequest.SubscriptionId
getset

The Server-assigned identifier for the Subscription that will report Notifications for this MonitoredItem.

TimestampsToReturn UnifiedAutomation.UaBase.CreateMonitoredItemsRequest.TimestampsToReturn
getset

An enumeration that specifies the timestamp Attributes to be transmitted for each MonitoredItem.

When monitoring Events, this applies only to Event fields that are of type DataValue.


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