Класс QOpcUaMonitoringParameters

Класс QOpcUaMonitoringParameters предоставляет способ установки и получения параметров для подписок и отслеживаемых элементов. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Открытые функции

Подробное описание

Этот класс используется в запросах QOpcUaNode::enableMonitoring() и в качестве значения возвращаемого результата для QOpcUaNode::monitoringStatus(), в этом случае он содержит пересмотренные значения с сервера.

Использование

Для большинства случаев использования требуется только интервал публикации.

QOpcUaMonitoringParameters p(100); // Set a publishing interval of 100ms and share the subscription.
node->enableMonitoring(QOpcUa::NodeAttribute::Value, p);

Если требуется подписка исключительного типа, используйте второй параметр.

QOpcUaMonitoringParameters p(100, QOpcUaMonitoringParameters::SubscriptionType::Exclusive); // Create a new subscription

Для добавления дополнительных элементов в существующую подписку используйте третий параметр для последующих вызовов QOpcUaNode::enableMonitoring().

quint32 subscriptionId = node->monitoringStatus(QOpcUa::NodeAttribute::Value).subscriptionId();
QOpcUaMonitoringParameters p(100, QOpcUaMonitoringParameters::SubscriptionType::Shared, subscriptionId); // Add the monitored item to this subscription

Если требуются другие параметры, их необходимо установить с помощью методов-сеттеров.

Поддержка бэкенда

Не все параметры в этом классе поддерживаются всеми бэкендами.

Документация по типам членов

Перечисление QOpcUaMonitoringParameters::MonitoringMode

Это перечисление используется для установки режима мониторинга отслеживаемого элемента.

Перечисление QOpcUaMonitoringParameters::Parameterфлаги QOpcUaMonitoringParameters::Parameters

Перечисляет параметры, которые можно изменить во время выполнения с помощью QOpcUaNode::modifyMonitoring(). Не все значения гарантированно поддерживаются всеми плагинами. Отсутствие поддержки будет сообщено в сигнале QOpcUaNode::monitoringStatusChanged.

Тип Parameters — это псевдоним для QFlags<Parameter>. Он хранит логическое ИЛИ сочетание значений Parameter.

Перечисление QOpcUaMonitoringParameters::SubscriptionType

Это перечисление используется для определения, можно ли добавить отслеживаемый элемент в общую подписку, или необходимо создать новую подписку.

Документация по функциям-членам

QOpcUaMonitoringParameters::QOpcUaMonitoringParameters(const QOpcUaMonitoringParameters &other)

Создаёт объект QOpcuaMonitoringParameters из значения other.

QOpcUaMonitoringParameters::QOpcUaMonitoringParameters(double publishingInterval, QOpcUaMonitoringParameters::SubscriptionType shared = SubscriptionType::Shared, quint32 subscriptionId = 0)

Этот конструктор охватывает большинство случаев использования для пользователя Qt OPC UA. publishingInterval должен быть указан, shared и subscriptionId — необязательны.

QOpcUaMonitoringParameters::QOpcUaMonitoringParameters()

Конструктор по умолчанию для QOpcUaMonitoringParameters.

QOpcUaMonitoringParameters &QOpcUaMonitoringParameters::operator=(const QOpcUaMonitoringParameters &other)

Присваивает значение other этому объекту.

QOpcUaMonitoringParameters::~QOpcUaMonitoringParameters()

Деструктор для QOpcUaMonitoringParameters.

void QOpcUaMonitoringParameters::clearFilter()

Удаляет текущий фильтр из параметров мониторинга.

См. также filter() и setFilter().

void QOpcUaMonitoringParameters::clearFilterResult()

Удаляет текущий результат фильтра из параметров мониторинга.

См. также filterResult() и setFilterResult().

bool QOpcUaMonitoringParameters::discardOldest() const

Возвращает значение discardOldest отслеживаемого элемента.

См. также setDiscardOldest().

QVariant QOpcUaMonitoringParameters::filter() const

Возвращает текущий фильтр.

См. также setFilter().

QVariant QOpcUaMonitoringParameters::filterResult() const

Возвращает результат фильтра.

Это значение пустое для мониторинга атрибута. В случае мониторинга событий результат фильтра может быть пустым, если сервер не обнаружил ошибок в фильтре.

См. также setFilterResult().

QString QOpcUaMonitoringParameters::indexRange() const

Возвращает диапазон индексов для отслеживаемого элемента.

См. также setIndexRange().

bool QOpcUaMonitoringParameters::isPublishingEnabled() const

Возвращает режим публикации для подписки.

quint32 QOpcUaMonitoringParameters::lifetimeCount() const

Возвращает счётчик времени жизни подписки.

См. также setLifetimeCount().

quint32 QOpcUaMonitoringParameters::maxKeepAliveCount() const

Возвращает максимальное количество keep-alive для подписки.

См. также setMaxKeepAliveCount().

quint32 QOpcUaMonitoringParameters::maxNotificationsPerPublish() const

Возвращает максимальное количество уведомлений на публикацию подписки.

См. также setMaxNotificationsPerPublish().

quint32 QOpcUaMonitoringParameters::monitoredItemId() const

Возвращает идентификатор отслеживаемого элемента, назначенный сервером. Если идентификатор отслеживаемого элемента равен 0, отслеживаемый элемент не был успешно создан.

См. также setMonitoredItemId().

QOpcUaMonitoringParameters::MonitoringMode QOpcUaMonitoringParameters::monitoringMode() const

Возвращает режим мониторинга для отслеживаемого элемента.

См. также setMonitoringMode().

quint8 QOpcUaMonitoringParameters::priority() const

Возвращает приоритет подписки, используемой для отслеживаемого элемента.

См. также setPriority().

double QOpcUaMonitoringParameters::publishingInterval() const

Возвращает интервал публикации подписки. Интервал выражен в миллисекундах.

См. также setPublishingInterval().

quint32 QOpcUaMonitoringParameters::queueSize() const

Возвращает размер очереди отслеживаемого элемента.

См. также setQueueSize().

double QOpcUaMonitoringParameters::samplingInterval() const

Возвращает пересмотренный интервал выборки отслеживаемого элемента. Интервал выражен в миллисекундах.

См. также setSamplingInterval().

void QOpcUaMonitoringParameters::setDiscardOldest(bool discardOldest)

Устанавливает discardOldest в качестве параметра discardOldest для отслеживаемого элемента.

См. также discardOldest().

void QOpcUaMonitoringParameters::setFilter(const QOpcUaMonitoringParameters::DataChangeFilter &filter)

Устанавливает DataChangeFilter filter в качестве фильтра для отслеживаемого элемента. Если присутствует другой фильтр изменения данных или фильтр событий, он будет заменён.

Если сервер не принимает фильтр, это будет указано кодом состояния после завершения запроса QOpcUaNode::enableMonitoring().

См. также filter().

void QOpcUaMonitoringParameters::setFilter(const QOpcUaMonitoringParameters::EventFilter &eventFilter)

Запрашивает eventFilter в качестве фильтра для отслеживаемого элемента. Если присутствует другой фильтр событий или фильтр изменения данных, он будет заменён. Если сервер не принимает фильтр, это будет указано кодом состояния и результатом фильтра событий после завершения запроса QOpcUaNode::enableMonitoring().

См. также filter().

void QOpcUaMonitoringParameters::setFilterResult(const QOpcUaEventFilterResult &eventFilterResult)

Устанавливает результат фильтра событий в eventFilterResult.

Этот метод должен использоваться только бэкендом, установка результата фильтра событий пользователем не оказывает никакого эффекта.

См. также filterResult().

void QOpcUaMonitoringParameters::setIndexRange(const QString &indexRange)

Запрашивает indexRange в качестве диапазона индексов для отслеживаемого элемента. Подробнее о строке диапазона индексов см. QOpcUaNode::readAttributeRange().

См. также indexRange().

void QOpcUaMonitoringParameters::setLifetimeCount(quint32 lifetimeCount)

Запрос lifetimeCount в качестве счётчика срока службы подписки.

См. также lifetimeCount().

void QOpcUaMonitoringParameters::setMaxKeepAliveCount(quint32 maxKeepAliveCount)

Запрос maxKeepAliveCount в качестве максимального счётчика keep-alive для подписки.

См. также maxKeepAliveCount().

void QOpcUaMonitoringParameters::setMaxNotificationsPerPublish(quint32 maxNotificationsPerPublish)

Устанавливает maxNotificationsPerPublish в качестве максимального количества уведомлений на публикацию для подписки.

См. также maxNotificationsPerPublish().

void QOpcUaMonitoringParameters::setMonitoredItemId(quint32 monitoredItemId)

Устанавливает идентификатор отслеживаемого элемента в monitoredItemId.

Установка этого значения клиентом не имеет эффекта.

См. также monitoredItemId().

void QOpcUaMonitoringParameters::setMonitoringMode(QOpcUaMonitoringParameters::MonitoringMode monitoringMode)

Устанавливает monitoringMode в качестве режима мониторинга для отслеживаемого элемента.

См. также monitoringMode().

void QOpcUaMonitoringParameters::setPriority(quint8 priority)

Устанавливает priority в качестве приоритета подписки.

См. также priority().

void QOpcUaMonitoringParameters::setPublishingEnabled(bool publishingEnabled)

Устанавливает publishingEnabled в качестве режима публикации для подписки.

См. также isPublishingEnabled().

void QOpcUaMonitoringParameters::setPublishingInterval(double publishingInterval)

Запрашивает publishingInterval в качестве интервала публикации для подписки. Интервал выражен в миллисекундах.

См. также publishingInterval().

void QOpcUaMonitoringParameters::setQueueSize(quint32 queueSize)

Запрашивает queueSize в качестве размера очереди для отслеживаемого элемента.

См. также queueSize().

void QOpcUaMonitoringParameters::setSamplingInterval(double samplingInterval)

Запрашивает samplingInterval в качестве интервала выборки для отслеживаемого элемента. Интервал выражен в миллисекундах.

См. также samplingInterval().

void QOpcUaMonitoringParameters::setStatusCode(QOpcUa::UaStatusCode statusCode)

Устанавливает код состояния в statusCode.

См. также statusCode().

void QOpcUaMonitoringParameters::setSubscriptionId(quint32 subscriptionId)

Запрашивает создание отслеживаемых элементов на известной подписке с subscriptionId.

См. также subscriptionId().

void QOpcUaMonitoringParameters::setSubscriptionType(QOpcUaMonitoringParameters::SubscriptionType shared)

Запрашивает shared в качестве типа подписки для подписки.

См. также subscriptionType().

QOpcUa::UaStatusCode QOpcUaMonitoringParameters::statusCode() const

Возвращает код состояния создания отслеживаемого элемента.

См. также setStatusCode().

quint32 QOpcUaMonitoringParameters::subscriptionId() const

Возвращает назначенный идентификатор подписки.

См. также setSubscriptionId().

QOpcUaMonitoringParameters::SubscriptionType QOpcUaMonitoringParameters::subscriptionType() const

Возвращает тип подписки.

См. также setSubscriptionType().