#include <monitoreditem.hpp>

Detailed Description

Extended monitoring parameters with default values from open62541.

This is an extended version of UA_MonitoringParameters with the timestamps parameter. Parameters are passed by reference because illegal parameters can be revised by the server. The updated parameters reflect the actual values that the server will use.

See also: https://reference.opcfoundation.org/Core/Part4/v105/docs/7.21

Examples: client_subscription.cpp.

Definition at line 45 of file monitoreditem.hpp.

Public Attributes
TimestampsToReturn	timestamps = TimestampsToReturn::Both

double	samplingInterval = 250.0

ExtensionObject	filter

uint32_t	queueSize = 1

bool	discardOldest = true

Member Data Documentation

◆ timestamps

TimestampsToReturn opcua::services::MonitoringParametersEx::timestamps = TimestampsToReturn::Both

Timestamps to be transmitted. Won't be revised by the server.

Definition at line 47 of file monitoreditem.hpp.

◆ samplingInterval

double opcua::services::MonitoringParametersEx::samplingInterval = 250.0

Interval in milliseconds that defines the fastest rate at which the MonitoredItem should be accessed and evaluated.

The following values have special meaning:

0.0 to use the fastest practical rate
-1.0 to use the default sampling interval (publishing interval of the subscription)

Examples: client_subscription.cpp.

Definition at line 52 of file monitoreditem.hpp.

◆ filter

ExtensionObject opcua::services::MonitoringParametersEx::filter

Filter is used by the server to determine if the MonitoredItem should generate notifications.

The filter parameter type is an extensible parameter type and can be, for example, of type DataChangeFilter, EventFilter or AggregateFilter.

See also: https://reference.opcfoundation.org/Core/Part4/v105/docs/7.22

Definition at line 57 of file monitoreditem.hpp.

Referenced by opcua::Subscription< Connection >::subscribeEvent().

◆ queueSize

uint32_t opcua::services::MonitoringParametersEx::queueSize = 1

Size of the MonitoringItem queue.

The following values have special meaning:

0 to retrieve the server's default queue size
1 to retrieve the server's minimum queue size In the case of a queue overflow, an Event of the type EventQueueOverflowEventType is generated.

Definition at line 64 of file monitoreditem.hpp.

◆ discardOldest

bool opcua::services::MonitoringParametersEx::discardOldest = true

Discard policy when the queue is full.

true: the oldest (first) notification in the queue is discarded
false: the last notification added to the queue gets replaced with the new notification

Definition at line 68 of file monitoreditem.hpp.