.NET Based OPC UA Client/Server SDK
2.6.2.427
|
Parameters that define the monitoring characteristics of a MonitoredItem. More...
Inherits UnifiedAutomation.UaBase.IEncodeable.
Public Member Functions | |
MonitoringParameters () | |
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 | |
uint | ClientHandle [get, set] |
Client-supplied id of the MonitoredItem. More... | |
double | SamplingInterval [get, set] |
The interval in milliseconds that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated. More... | |
ExtensionObject | Filter [get, set] |
A filter used by the Server to determine if the MonitoredItem should generate a Notification. More... | |
uint | QueueSize [get, set] |
The requested size of the MonitoredItem queue. More... | |
bool | DiscardOldest [get, set] |
A boolean parameter that specifies the discard policy when the queue is full and a new Notification is to be enqueued. More... | |
virtual ExpandedNodeId | TypeId [get] |
virtual ExpandedNodeId | BinaryEncodingId [get] |
virtual ExpandedNodeId | XmlEncodingId [get] |
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... | |
Parameters that define the monitoring characteristics of a MonitoredItem.
|
inline |
The default constructor.
|
inlinevirtual |
Checks if encodeable is the same object or has the same content
encodeable |
Implements UnifiedAutomation.UaBase.IEncodeable.
|
getset |
Client-supplied id of the MonitoredItem.
This id is used in Notifications generated for the list Node.
|
getset |
A boolean parameter that specifies the discard policy when the queue is full and a new Notification is to be enqueued.
It has the following values:
|
getset |
A filter used by the Server to determine if the MonitoredItem should generate a Notification.
If not used, this parameter is null. The MonitoringFilter parameter type is an extensible parameter type. It specifies the types of filters that can be used.
|
getset |
The requested size of the MonitoredItem queue.
The following values have special meaning for data monitored items:
For values larger than one a first-in-first-out queue is to be used. The Server may limit the size in revisedQueueSize. In the case of a queue overflow, the Overflow bit (flag) in the InfoBits portion of the DataValue statusCode is set in the new value.
The following values have special meaning for event monitored items:
If a Client chooses a value between the minimum and maximum settings of the Server the value shall be returned in the revisedQueueSize. If the requested queueSize is outside the minimum or maximum, the Server shall return the corresponding bounding value.
In the case of a queue overflow, an Event of the type EventQueueOverflowEventType is generated.
|
getset |
The interval in milliseconds that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated.
The value 0 indicates that the Server should use the fastest practical rate.
The value -1 indicates that the default sampling interval defined by the publishing interval of the Subscription is requested. A different sampling interval is used if the publishing interval is not a supported sampling interval. Any negative number is interpreted as -1. The sampling interval is not changed if the publishing interval is changed by a subsequent call to the ModifySubscription Service.
The Server uses this parameter to assign the MonitoredItems to a sampling interval that it supports.
The assigned interval is provided in the revisedSamplingInterval parameter. The Server shall always return a revisedSamplingInterval that is equal or higher than the requested samplingInterval. If the requested samplingInterval is higher than the maximum sampling interval supported by the Server, the maximum sampling interval is returned.