QOpcUaMonitoringParameters Class
QOpcUaMonitoringParameters proporciona una forma de establecer y recuperar parámetros para suscripciones y elementos monitorizados. Más...
| Cabecera: | #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 peticiones QOpcUaNode::enableMonitoring() y como valor de retorno para QOpcUaNode::monitoringStatus() en cuyo caso contiene los valores revisados del servidor.
Uso
Para la mayoría de los casos de uso, sólo 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 a exclusive, utilice el segundo parámetro.
QOpcUaMonitoringParameters p(100, QOpcUaMonitoringParameters::SubscriptionType::Exclusive); // Create a new subscription
Para añadir elementos adicionales a una suscripción existente, utilice el tercer parámetro para 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 subscription
Si se requieren otros parámetros, deben establecerse utilizando los métodos setter.
Documentación de tipos de miembros
enum class QOpcUaMonitoringParameters::MonitoringMode
Este enum se utiliza para establecer 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á habilitado y se generan y ponen en cola notificaciones, pero los informes están deshabilitados. |
QOpcUaMonitoringParameters::MonitoringMode::Reporting | 2 | El muestreo está habilitado, las notificaciones se generan y se ponen en cola, los informes están habilitados. |
enum class QOpcUaMonitoringParameters::Parameter
flags QOpcUaMonitoringParameters::Parameters
Enumera los parámetros que pueden modificarse en tiempo de ejecución mediante QOpcUaNode::modifyMonitoring(). No se garantiza que todos los valores sean soportados por todos los plugins. La falta de soporte será reportada en 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 un typedef para QFlags<Parameter>. Almacena una combinación OR de valores de Parámetros.
enum class QOpcUaMonitoringParameters::SubscriptionType
Este enum se utiliza para determinar si el elemento supervisado puede añadirse a una suscripción compartida o si debe crearse una nueva suscripción.
| Constante | Valor | Descripción |
|---|---|---|
QOpcUaMonitoringParameters::SubscriptionType::Shared | 0 | Compartir 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 la función 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 Qt OPC UA. publishingInterval debe ser suministrado, shared y subscriptionId son opcionales.
QOpcUaMonitoringParameters::QOpcUaMonitoringParameters(const QOpcUaMonitoringParameters &other)
Construye 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 monitorización.
Véase también filter() y setFilter().
void QOpcUaMonitoringParameters::clearFilterResult()
Elimina el resultado del filtro actual de los parámetros de monitorización.
Véase también filterResult() y setFilterResult().
bool QOpcUaMonitoringParameters::discardOldest() const
Devuelve el ajuste 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 desde 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 una monitorización de atributos. En el caso de una monitorización de eventos, el resultado del filtro puede estar vacío si el servidor no detectó 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 de tiempo de vida de la suscripción.
Véase también setLifetimeCount().
quint32 QOpcUaMonitoringParameters::maxKeepAliveCount() const
Devuelve el número máximo de keepalive 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 id del elemento supervisado asignado por el servidor. Si el id del ítem monitoreado es 0, el ítem monitoreado no pudo ser creado exitosamente.
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)
Configure discardOldest como 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 cambio de datos o un filtro de eventos, éste será sustituido.
Si el servidor no acepta el filtro, 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 de cambio de datos, será sustituido. Si el servidor no acepta el filtro, 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 sólo 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 índice para el elemento supervisado. Para más detalles sobre la cadena de rango de índice, véase QOpcUaNode::readAttributeRange().
Véase también indexRange().
void QOpcUaMonitoringParameters::setLifetimeCount(quint32 lifetimeCount)
Solicita lifetimeCount como recuento de tiempo de vida de la suscripción.
Véase también lifetimeCount().
void QOpcUaMonitoringParameters::setMaxKeepAliveCount(quint32 maxKeepAliveCount)
Solicita maxKeepAliveCount como número máximo de keepalive para la suscripción.
Véase también maxKeepAliveCount().
void QOpcUaMonitoringParameters::setMaxNotificationsPerPublish(quint32 maxNotificationsPerPublish)
Establezca 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 id 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)
Establezca 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)
Establezca 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)
Solicita queueSize como tamaño de 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 la creación de los elementos supervisados en una suscripción conocida con subscriptionId.
Véase también subscriptionId().
void QOpcUaMonitoringParameters::setSubscriptionType(QOpcUaMonitoringParameters::SubscriptionType shared)
Solicita 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, como se describe en OPC UA 1.05, 5.12.1.6.
Los valores de ids deben ser los Id. de elementos supervisados de otros elementos supervisados de la misma suscripción. Si el modo de supervisión de estos elementos se establece en Muestreo, sus notificaciones de cambio de datos se enviarán al cliente siempre que esta supervisión detecte un cambio de datos.
Los ids que no se hayan podido añadir no se incluirán en el estado de monitorización, sino que aparecerán en failedTriggeredItemsStatus().
La modificación de esta configuración a un conjunto vacío eliminará todos los enlaces desencadenantes.
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 id 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 ids de los elementos monitorizados desencadenados por este elemento monitorizado.
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.
