QOpcUaMonitoringParameters Class
QOpcUaMonitoringParameters permite configurar y recuperar parámetros para suscripciones y elementos supervisados. Más información...
| Encabezado: | #include <QOpcUaMonitoringParameters> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS OpcUa) target_link_libraries(mytarget PRIVATE Qt6::OpcUa) |
| qmake: | QT += opcua |
Tipos públicos
| class | DataChangeFilter |
| class | EventFilter |
| enum class | MonitoringMode { Disabled, Sampling, Reporting } |
| enum class | Parameter { PublishingEnabled, PublishingInterval, LifetimeCount, MaxKeepAliveCount, MaxNotificationsPerPublish, …, TriggeredItemIds } |
| flags | Parameters |
| enum class | SubscriptionType { Shared, Exclusive } |
Funciones públicas
| QOpcUaMonitoringParameters() | |
| QOpcUaMonitoringParameters(double publishingInterval, QOpcUaMonitoringParameters::SubscriptionType shared = SubscriptionType::Shared, quint32 subscriptionId = 0) | |
| QOpcUaMonitoringParameters(const QOpcUaMonitoringParameters &other) | |
| ~QOpcUaMonitoringParameters() | |
| void | clearFilter() |
| void | clearFilterResult() |
| bool | discardOldest() const |
(since 6.7) QHash<quint32, QOpcUa::UaStatusCode> | failedTriggeredItemsStatus() const |
| QVariant | filter() const |
| QVariant | filterResult() const |
| QString | indexRange() const |
| bool | isPublishingEnabled() const |
| quint32 | lifetimeCount() const |
| quint32 | maxKeepAliveCount() const |
| quint32 | maxNotificationsPerPublish() const |
| quint32 | monitoredItemId() const |
| QOpcUaMonitoringParameters::MonitoringMode | monitoringMode() const |
| quint8 | priority() const |
| double | publishingInterval() const |
| quint32 | queueSize() const |
| double | samplingInterval() const |
| void | setDiscardOldest(bool discardOldest) |
(since 6.7) void | setFailedTriggeredItemsStatus(const QHash<quint32, QOpcUa::UaStatusCode> &status) |
| void | setFilter(const QOpcUaMonitoringParameters::DataChangeFilter &filter) |
| void | setFilter(const QOpcUaMonitoringParameters::EventFilter &eventFilter) |
| void | setFilterResult(const QOpcUaEventFilterResult &eventFilterResult) |
| void | setIndexRange(const QString &indexRange) |
| void | setLifetimeCount(quint32 lifetimeCount) |
| void | setMaxKeepAliveCount(quint32 maxKeepAliveCount) |
| void | setMaxNotificationsPerPublish(quint32 maxNotificationsPerPublish) |
| void | setMonitoredItemId(quint32 monitoredItemId) |
| void | setMonitoringMode(QOpcUaMonitoringParameters::MonitoringMode monitoringMode) |
| void | setPriority(quint8 priority) |
| void | setPublishingEnabled(bool publishingEnabled) |
| void | setPublishingInterval(double publishingInterval) |
| void | setQueueSize(quint32 queueSize) |
| void | setSamplingInterval(double samplingInterval) |
| void | setStatusCode(QOpcUa::UaStatusCode statusCode) |
| void | setSubscriptionId(quint32 subscriptionId) |
| void | setSubscriptionType(QOpcUaMonitoringParameters::SubscriptionType shared) |
(since 6.7) void | setTriggeredItemIds(const QSet<quint32> &ids) |
| QOpcUa::UaStatusCode | statusCode() const |
| quint32 | subscriptionId() const |
| QOpcUaMonitoringParameters::SubscriptionType | subscriptionType() const |
(since 6.7) QSet<quint32> | triggeredItemIds() const |
| QOpcUaMonitoringParameters & | operator=(const QOpcUaMonitoringParameters &other) |
Descripción detallada
Esta clase se utiliza en las solicitudes ` QOpcUaNode::enableMonitoring()` y como valor de retorno para ` QOpcUaNode::monitoringStatus()`, en cuyo caso contiene los valores actualizados procedentes del servidor.
Uso
En la mayoría de los casos, solo se requiere el intervalo de publicación.
QOpcUaMonitoringParameters p(100); // Set a publishing interval of 100ms and share the subscription.
node->enableMonitoring(QOpcUa::NodeAttribute::Value, p);Si se requiere una suscripción exclusive, utilice el segundo parámetro.
QOpcUaMonitoringParameters p(100, QOpcUaMonitoringParameters::SubscriptionType::Exclusive); // Create a new subscriptionPara añadir elementos adicionales a una suscripción existente, utiliza el tercer parámetro en las siguientes llamadas a QOpcUaNode::enableMonitoring().
quint32 subscriptionId = node->monitoringStatus(QOpcUa::NodeAttribute::Value).subscriptionId();
QOpcUaMonitoringParameters p(100, QOpcUaMonitoringParameters::SubscriptionType::Shared, subscriptionId); // Add the monitored item to this subscriptionSi se requieren otros parámetros, deben configurarse mediante los métodos setter.
Documentación sobre los tipos de miembros
enum class QOpcUaMonitoringParameters::MonitoringMode
Esta enumeración se utiliza para configurar el modo de supervisión de un elemento supervisado.
| Constante | Valor | Descripción |
|---|---|---|
QOpcUaMonitoringParameters::MonitoringMode::Disabled | 0 | El muestreo está desactivado y no se generan notificaciones. |
QOpcUaMonitoringParameters::MonitoringMode::Sampling | 1 | El muestreo está activado y se generan y ponen en cola notificaciones, pero la generación de informes está desactivada. |
QOpcUaMonitoringParameters::MonitoringMode::Reporting | 2 | El muestreo está activado, se generan notificaciones y se colocan en cola, y la generación de informes está activada. |
enum class QOpcUaMonitoringParameters::Parameter
flags QOpcUaMonitoringParameters::Parameters
Enumera los parámetros que se pueden modificar en tiempo de ejecución mediante ` QOpcUaNode::modifyMonitoring()`. No se garantiza que todos los complementos admitan todos los valores. La falta de compatibilidad se notificará mediante la señal ` QOpcUaNode::monitoringStatusChanged `.
| Constante | Valor |
|---|---|
QOpcUaMonitoringParameters::Parameter::PublishingEnabled | (1 << 0) |
QOpcUaMonitoringParameters::Parameter::PublishingInterval | (1 << 1) |
QOpcUaMonitoringParameters::Parameter::LifetimeCount | (1 << 2) |
QOpcUaMonitoringParameters::Parameter::MaxKeepAliveCount | (1 << 3) |
QOpcUaMonitoringParameters::Parameter::MaxNotificationsPerPublish | (1 << 4) |
QOpcUaMonitoringParameters::Parameter::Priority | (1 << 5) |
QOpcUaMonitoringParameters::Parameter::SamplingInterval | (1 << 6) |
QOpcUaMonitoringParameters::Parameter::Filter | (1 << 7) |
QOpcUaMonitoringParameters::Parameter::QueueSize | (1 << 8) |
QOpcUaMonitoringParameters::Parameter::DiscardOldest | (1 << 9) |
QOpcUaMonitoringParameters::Parameter::MonitoringMode | (1 << 10) |
QOpcUaMonitoringParameters::Parameter::TriggeredItemIds (since Qt 6.7) | (1 << 11) |
El tipo «Parameters» es una definición de tipo (typedef) para QFlags<Parameter>. Almacena una combinación OR de valores de «Parameter».
enum class QOpcUaMonitoringParameters::SubscriptionType
Esta enumeración se utiliza para determinar si el elemento supervisado puede añadirse a una suscripción compartida o si es necesario crear una nueva suscripción.
| Constante | Valor | Descripción |
|---|---|---|
QOpcUaMonitoringParameters::SubscriptionType::Shared | 0 | Compartir la suscripción con otros elementos supervisados con el mismo intervalo |
QOpcUaMonitoringParameters::SubscriptionType::Exclusive | 1 | Solicitar una nueva suscripción para este atributo |
Documentación de funciones de miembro
QOpcUaMonitoringParameters::QOpcUaMonitoringParameters()
El constructor por defecto de QOpcUaMonitoringParameters.
QOpcUaMonitoringParameters::QOpcUaMonitoringParameters(double publishingInterval, QOpcUaMonitoringParameters::SubscriptionType shared = SubscriptionType::Shared, quint32 subscriptionId = 0)
Este es el constructor que cubre la mayoría de los casos de uso para el usuario de Qt OPC UA. Es obligatorio proporcionar publishingInterval; shared y subscriptionId son opcionales.
QOpcUaMonitoringParameters::QOpcUaMonitoringParameters(const QOpcUaMonitoringParameters &other)
Crea un objeto `QOpcuaMonitoringParameters` a partir del valor de ` other`.
[noexcept] QOpcUaMonitoringParameters::~QOpcUaMonitoringParameters()
El destructor de ` QOpcUaMonitoringParameters`.
void QOpcUaMonitoringParameters::clearFilter()
Elimina el filtro actual de los parámetros de supervisión.
Véase también filter() y setFilter().
void QOpcUaMonitoringParameters::clearFilterResult()
Elimina el resultado actual del filtro de los parámetros de supervisión.
Véase también filterResult() y setFilterResult().
bool QOpcUaMonitoringParameters::discardOldest() const
Devuelve el valor de la configuración «discardOldest» del elemento supervisado.
Véase también ` setDiscardOldest()`.
[since 6.7] QHash<quint32, QOpcUa::UaStatusCode> QOpcUaMonitoringParameters::failedTriggeredItemsStatus() const
Devuelve los códigos de estado de todos los elementos activados mediante ` setTriggeredItemIds()` que no se han podido añadir correctamente.
Esta función se introdujo en Qt 6.7.
Véase también setFailedTriggeredItemsStatus().
QVariant QOpcUaMonitoringParameters::filter() const
Devuelve el filtro actual.
Véase también setFilter().
QVariant QOpcUaMonitoringParameters::filterResult() const
Devuelve el resultado del filtro.
Este valor está vacío en el caso de la supervisión de atributos. En el caso de la supervisión de eventos, el resultado del filtro puede estar vacío si el servidor no ha detectado ningún error en el filtro.
Véase también setFilterResult().
QString QOpcUaMonitoringParameters::indexRange() const
Devuelve el rango de índices del elemento supervisado.
Véase también setIndexRange().
bool QOpcUaMonitoringParameters::isPublishingEnabled() const
Devuelve el modo de publicación de la suscripción.
quint32 QOpcUaMonitoringParameters::lifetimeCount() const
Devuelve el recuento total de la suscripción.
Véase también setLifetimeCount().
quint32 QOpcUaMonitoringParameters::maxKeepAliveCount() const
Devuelve el número máximo de intentos de reconexión de la suscripción.
Véase también setMaxKeepAliveCount().
quint32 QOpcUaMonitoringParameters::maxNotificationsPerPublish() const
Devuelve el valor máximo de notificaciones por publicación de la suscripción.
Véase también setMaxNotificationsPerPublish().
quint32 QOpcUaMonitoringParameters::monitoredItemId() const
Devuelve el identificador del elemento supervisado asignado por el servidor. Si el identificador del elemento supervisado es 0, significa que no se ha podido crear correctamente el elemento supervisado.
Véase también setMonitoredItemId().
QOpcUaMonitoringParameters::MonitoringMode QOpcUaMonitoringParameters::monitoringMode() const
Devuelve el modo de supervisión del elemento supervisado.
Véase también setMonitoringMode().
quint8 QOpcUaMonitoringParameters::priority() const
Devuelve la prioridad de la suscripción utilizada para el elemento supervisado.
Véase también setPriority().
double QOpcUaMonitoringParameters::publishingInterval() const
Devuelve el intervalo de publicación de la suscripción. El intervalo se expresa en milisegundos.
Véase también setPublishingInterval().
quint32 QOpcUaMonitoringParameters::queueSize() const
Devuelve el tamaño de la cola del elemento supervisado.
Véase también setQueueSize().
double QOpcUaMonitoringParameters::samplingInterval() const
Devuelve el intervalo de muestreo revisado del elemento supervisado. El intervalo se expresa en milisegundos.
Véase también setSamplingInterval().
void QOpcUaMonitoringParameters::setDiscardOldest(bool discardOldest)
Establece « discardOldest » como valor de la configuración « discardOldest » para el elemento supervisado.
Véase también discardOldest().
[since 6.7] void QOpcUaMonitoringParameters::setFailedTriggeredItemsStatus(const QHash<quint32, QOpcUa::UaStatusCode> &status)
Establece los códigos de estado de todos los elementos activados que no se han podido añadir correctamente a status. Establecer este valor como cliente no tiene ningún efecto.
Esta función se introdujo en Qt 6.7.
Véase también failedTriggeredItemsStatus().
void QOpcUaMonitoringParameters::setFilter(const QOpcUaMonitoringParameters::DataChangeFilter &filter)
Establece DataChangeFilter filter como filtro para el elemento supervisado. Si existe otro filtro de cambios en los datos o un filtro de eventos, este será sustituido.
Si el servidor no acepta el filtro, esto se indicará mediante el código de estado una vez finalizada la solicitud QOpcUaNode::enableMonitoring().
Véase también filter().
void QOpcUaMonitoringParameters::setFilter(const QOpcUaMonitoringParameters::EventFilter &eventFilter)
Solicita « eventFilter » como filtro para el elemento supervisado. Si existe otro filtro de eventos o un filtro de cambio de datos, este será sustituido. Si el servidor no acepta el filtro, esto se indicará mediante el código de estado y el resultado del filtro de eventos una vez finalizada la solicitud « QOpcUaNode::enableMonitoring()».
Véase también filter().
void QOpcUaMonitoringParameters::setFilterResult(const QOpcUaEventFilterResult &eventFilterResult)
Establece el resultado del filtro de eventos en « eventFilterResult ».
Este método solo debe ser utilizado por el backend; establecer un resultado de filtro de eventos como usuario no tiene ningún efecto.
Véase también filterResult().
void QOpcUaMonitoringParameters::setIndexRange(const QString &indexRange)
Solicita indexRange como rango de índices para el elemento supervisado. Para obtener más información sobre la cadena de rango de índices, consulta QOpcUaNode::readAttributeRange().
Véase también indexRange().
void QOpcUaMonitoringParameters::setLifetimeCount(quint32 lifetimeCount)
Solicita « lifetimeCount » como recuento total de la suscripción.
Véase también lifetimeCount().
void QOpcUaMonitoringParameters::setMaxKeepAliveCount(quint32 maxKeepAliveCount)
Establece maxKeepAliveCount como número máximo de keepalive para la suscripción.
Véase también maxKeepAliveCount().
void QOpcUaMonitoringParameters::setMaxNotificationsPerPublish(quint32 maxNotificationsPerPublish)
Establece maxNotificationsPerPublish como valor máximo de notificaciones por publicación para la suscripción.
Véase también maxNotificationsPerPublish().
void QOpcUaMonitoringParameters::setMonitoredItemId(quint32 monitoredItemId)
Establece el identificador del elemento supervisado en monitoredItemId.
Establecer este valor como cliente no tiene ningún efecto.
Véase también monitoredItemId().
void QOpcUaMonitoringParameters::setMonitoringMode(QOpcUaMonitoringParameters::MonitoringMode monitoringMode)
Establece « monitoringMode » como modo de supervisión para el elemento supervisado.
Véase también monitoringMode().
void QOpcUaMonitoringParameters::setPriority(quint8 priority)
Establece priority como prioridad para la suscripción.
Véase también priority().
void QOpcUaMonitoringParameters::setPublishingEnabled(bool publishingEnabled)
Establece publishingEnabled como modo de publicación para la suscripción.
Véase también isPublishingEnabled().
void QOpcUaMonitoringParameters::setPublishingInterval(double publishingInterval)
Solicita publishingInterval como intervalo de publicación para la suscripción. El intervalo se expresa en milisegundos.
Véase también publishingInterval().
void QOpcUaMonitoringParameters::setQueueSize(quint32 queueSize)
Establece « queueSize » como tamaño de la cola para el elemento supervisado.
Véase también queueSize().
void QOpcUaMonitoringParameters::setSamplingInterval(double samplingInterval)
Solicita samplingInterval como intervalo de muestreo para el elemento supervisado. El intervalo se expresa en milisegundos.
Véase también samplingInterval().
void QOpcUaMonitoringParameters::setStatusCode(QOpcUa::UaStatusCode statusCode)
Establece el código de estado en « statusCode ».
Véase también statusCode().
void QOpcUaMonitoringParameters::setSubscriptionId(quint32 subscriptionId)
Solicita que se creen los elementos supervisados en una suscripción conocida mediante subscriptionId.
Véase también subscriptionId().
void QOpcUaMonitoringParameters::setSubscriptionType(QOpcUaMonitoringParameters::SubscriptionType shared)
Selecciona « shared » como tipo de suscripción para la suscripción.
Véase también subscriptionType().
[since 6.7] void QOpcUaMonitoringParameters::setTriggeredItemIds(const QSet<quint32> &ids)
Añade enlaces de activación a todos los elementos supervisados en ids, tal y como se describe en OPC UA 1.05, 5.12.1.6.
Los valores de « ids » deben ser los identificadores de otros elementos supervisados que se encuentren en la misma suscripción. Si el modo de supervisión de estos elementos está configurado como «Muestreo», las notificaciones de cambio de datos se enviarán al cliente cada vez que esta supervisión detecte un cambio en los datos.
Los identificadores que no se hayan podido añadir no se incluirán en el estado de monitorización, sino que aparecerán en failedTriggeredItemsStatus().
Si se modifica esta configuración para dejarla vacía, se eliminarán todos los enlaces de activación.
Esta función se introdujo en Qt 6.7.
Véase también triggeredItemIds().
QOpcUa::UaStatusCode QOpcUaMonitoringParameters::statusCode() const
Devuelve el código de estado de la creación del elemento supervisado.
Véase también setStatusCode().
quint32 QOpcUaMonitoringParameters::subscriptionId() const
Devuelve el identificador de suscripción asignado.
Véase también setSubscriptionId().
QOpcUaMonitoringParameters::SubscriptionType QOpcUaMonitoringParameters::subscriptionType() const
Devuelve el tipo de suscripción.
Véase también setSubscriptionType().
[since 6.7] QSet<quint32> QOpcUaMonitoringParameters::triggeredItemIds() const
Devuelve los identificadores de los elementos supervisados activados por este elemento supervisado.
Esta función se introdujo en Qt 6.7.
Véase también setTriggeredItemIds().
QOpcUaMonitoringParameters &QOpcUaMonitoringParameters::operator=(const QOpcUaMonitoringParameters &other)
Asigna el valor de « other » a este objeto.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.