QOpcUaGenericStructHandler Class
Lee los tipos de datos de un servidor y decodifica/codifica estructuras genéricas desde/hacia objetos de extensión. Más información...
| Encabezado: | #include <QOpcUaGenericStructHandler> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS OpcUa) target_link_libraries(mytarget PRIVATE Qt6::OpcUa) |
| qmake: | QT += opcua |
| Desde: | Qt 6.7 |
| Heredado de: | QObject |
Tipos públicos
| enum class | DataTypeKind { Unknown, Struct, Enum, Other } |
Funciones públicas
| QOpcUaGenericStructHandler(QOpcUaClient *client, QObject *parent = nullptr) | |
| bool | addCustomEnumDefinition(const QOpcUaEnumDefinition &definition, const QString &typeId, const QString &name, QOpcUa::IsAbstract isAbstract = QOpcUa::IsAbstract::NotAbstract) |
| bool | addCustomStructureDefinition(const QOpcUaStructureDefinition &definition, const QString &typeId, const QString &name, QOpcUa::IsAbstract isAbstract = QOpcUa::IsAbstract::NotAbstract) |
| QOpcUaGenericStructValue | createGenericStructValueForTypeId(const QString &typeId) |
| QOpcUaGenericStructHandler::DataTypeKind | dataTypeKindForTypeId(const QString &id) const |
| std::optional<QOpcUaGenericStructValue> | decode(const QOpcUaExtensionObject &extensionObject) const |
| std::optional<QOpcUaExtensionObject> | encode(const QOpcUaGenericStructValue &value) |
| QOpcUaEnumDefinition | enumDefinitionForTypeId(const QString &id) const |
| bool | initialize() |
(since 6.7) bool | initialized() const |
| bool | isAbstractTypeId(const QString &id) const |
| QOpcUaStructureDefinition | structureDefinitionForBinaryEncodingId(const QString &id) const |
| QOpcUaStructureDefinition | structureDefinitionForTypeId(const QString &id) const |
| QString | typeIdForBinaryEncodingId(const QString &id) const |
| QString | typeNameForBinaryEncodingId(const QString &id) const |
| QString | typeNameForTypeId(const QString &id) const |
Señales
| void | initializedChanged(bool initialized) |
Descripción detallada
La codificación de datos binarios utilizada en OPC UA se diseñó pensando en mensajes de tamaño reducido y no contiene ninguna información sobre la estructura de los datos. Esto significa que un decodificador debe conocer de antemano la estructura de los datos codificados para poder decodificar un búfer de datos.
Desde la versión 1.04 de OPC UA, los nodos de la clase de nodos «DataType» pueden tener el atributo «DataTypeDefinition», que contiene información sobre los campos de los tipos estructurados y la correspondencia entre los valores de enumeración y los nombres. Junto con el conocimiento sobre cómo descodificar los tipos integrados, esto permite a un cliente descodificar tipos estructurados genéricos personalizados sin necesidad de recurrir a información externa.
QOpcUaGenericStructHandler recorre la jerarquía de tipos de un servidor siguiendo las referencias HasSubtype a partir de BaseDataType y lee el atributo DataTypeDefinition de los nodos.
En el caso de los tipos estructurados en los que aparece un valor « QOpcUaStructureDefinition » en el atributo «DataTypeDefinition», se dispone de la decodificación automática de los objetos de extensión que los contienen. Los campos con un tipo integrado o un tipo para el que existe una clase de datos de C++ se deserializan al tipo « Qt OPC UA » correspondiente; el resto de estructuras genéricas se serializan a un « QOpcUaGenericStructValue » anidado. Todos los valores de estructuras genéricas anidadas deben tener un « QOpcUaStructureDefinition » en el servidor; de lo contrario, la decodificación fallará.
Las mismas condiciones se aplican a la codificación de una estructura personalizada.
Ejemplo de decodificación de una estructura personalizada:
QOpcUaGenericStructHandler handler(opcuaClient);
handler.initialize();
QObject::connect(&handler, &QOpcUaGenericStructHandler::initializedChanged, [opcuaClient, &handler](bool initialized) {
if (!initialized)
return;
auto node = opcuaClient->node("ns=4;i=3003"); // Un nodo de prueba con una estructura personalizada en el servidor de pruebas open62541-testserver
node->readValueAttribute();
QObject::connect(nodo, &QOpcUaNode::attributeRead, [nodo, &handler](QOpcUa::NodeAttributes attr) {
if (!attr.testFlag(QOpcUa::NodeAttribute::Value)|| node->valueAttributeError() != QOpcUa::UaStatusCode::Good)
return;
auto extObj = node->valueAttribute().value<QOpcUaExtensionObject>();
qDebug() << "Got object of type" << handler.typeNameForBinaryEncodingId(extObj.encodingTypeId());
const auto result = handler.decode(extObj);
if (!result)
return;
qDebug() << *result;
});
});Ejemplo de codificación de una estructura personalizada:
QOpcUaGenericStructHandler handler(opcuaClient);
handler.initialize();
QObject::connect(&handler, &QOpcUaGenericStructHandler::initializedChanged, [opcuaClient, &handler](bool initialized) {
if (!initialized)
return;
QOpcUaGenericStructValue value = handler.createGenericStructValueForTypeId("ns=4;i=3006");
value.fieldsRef()["MandatoryMember"] = 23.0;
value.fieldsRef()["OptionalMember"] = 42.0;
const auto ext = handler.encode(value);
if (!ext)
return;
// Use the extension object to write a node's value attribute, in a method parameter, etc...
});Documentación sobre los tipos de miembros
enum class QOpcUaGenericStructHandler::DataTypeKind
Este tipo de enumeración especifica el tipo de datos de un nodo de tipo de datos.
| Constante | Valor | Descripción |
|---|---|---|
QOpcUaGenericStructHandler::DataTypeKind::Unknown | 0 | Se desconoce el identificador del nodo de tipo. |
QOpcUaGenericStructHandler::DataTypeKind::Struct | 1 | El identificador del nodo de tipo pertenece a un tipo estructurado. |
QOpcUaGenericStructHandler::DataTypeKind::Enum | 2 | El identificador del nodo de tipo pertenece a un tipo enumerado. |
QOpcUaGenericStructHandler::DataTypeKind::Other | 3 | El identificador del nodo de tipo pertenece a un tipo que no es una estructura ni una enumeración (otros tipos integrados o sus subtipos) |
Documentación de funciones de miembro
[explicit] QOpcUaGenericStructHandler::QOpcUaGenericStructHandler(QOpcUaClient *client, QObject *parent = nullptr)
Crea un controlador de estructuras genérico para client.
bool QOpcUaGenericStructHandler::addCustomEnumDefinition(const QOpcUaEnumDefinition &definition, const QString &typeId, const QString &name, QOpcUa::IsAbstract isAbstract = QOpcUa::IsAbstract::NotAbstract)
Añade la definición de enumeración personalizada definition a los tipos conocidos. Esto puede utilizarse para admitir estructuras personalizadas para las que el servidor no expone una StructureDefinition. Los parámetros definition, typeId y name son obligatorios para una codificación y decodificación correctas. Si se establece isAbstract, el tipo no podrá codificarse ni decodificarse.
Devuelve « true » si la definición de la enumeración se ha añadido correctamente.
bool QOpcUaGenericStructHandler::addCustomStructureDefinition(const QOpcUaStructureDefinition &definition, const QString &typeId, const QString &name, QOpcUa::IsAbstract isAbstract = QOpcUa::IsAbstract::NotAbstract)
Añade la definición de estructura personalizada definition a los tipos conocidos. Esto puede utilizarse para admitir estructuras personalizadas para las que el servidor no expone una StructureDefinition. Los parámetros definition, typeId y name son obligatorios para una decodificación y codificación correctas. Si se establece isAbstract, el tipo no se puede codificar ni decodificar.
Devuelve « true » si la definición de la estructura se ha añadido correctamente.
QOpcUaGenericStructValue QOpcUaGenericStructHandler::createGenericStructValueForTypeId(const QString &typeId)
Devuelve un valor de estructura genérico prellenado con la definición de la estructura, el identificador de tipo y el nombre del tipo correspondientes a typeId. En todos los campos obligatorios se insertará un marcador de posición no válido: QVariant.
QOpcUaGenericStructHandler::DataTypeKind QOpcUaGenericStructHandler::dataTypeKindForTypeId(const QString &id) const
Devuelve el tipo de datos «kind» correspondiente al nodo de tipo con el identificador id.
std::optional<QOpcUaGenericStructValue> QOpcUaGenericStructHandler::decode(const QOpcUaExtensionObject &extensionObject) const
Decodifica extensionObject en QOpcUaGenericStructValue. Si la decodificación falla, se devuelve std::nullopt.
std::optional<QOpcUaExtensionObject> QOpcUaGenericStructHandler::encode(const QOpcUaGenericStructValue &value)
Devuelve un objeto ` value ` codificado como ` QOpcUaExtensionObject`, o ` std::nullopt ` si no se ha podido codificar el valor.
QOpcUaEnumDefinition QOpcUaGenericStructHandler::enumDefinitionForTypeId(const QString &id) const
Devuelve el objeto ` QOpcUaEnumDefinition ` correspondiente al identificador de nodo de tipo ` id`. Si se desconoce el identificador de nodo o este no pertenece a un tipo de enumeración, se devuelve un valor construido por defecto.
bool QOpcUaGenericStructHandler::initialize()
Inicia el recorrido de la jerarquía de tipos de datos. El éxito o el fallo se indican mediante la señal « initializedChanged ».
Devuelve « false » si no se puede iniciar la operación.
[since 6.7] bool QOpcUaGenericStructHandler::initialized() const
Devuelve « true » si el controlador de estructuras genéricas está inicializado.
Esta función se introdujo en Qt 6.7.
[signal] void QOpcUaGenericStructHandler::initializedChanged(bool initialized)
Esta señal se emite cuando finaliza el proceso de inicialización. La variable ` initialized ` indica si la inicialización se ha realizado correctamente.
bool QOpcUaGenericStructHandler::isAbstractTypeId(const QString &id) const
Devuelve «true» si el tipo de datos descrito por ` id ` es abstracto.
QOpcUaStructureDefinition QOpcUaGenericStructHandler::structureDefinitionForBinaryEncodingId(const QString &id) const
Devuelve el objeto ` QOpcUaStructureDefinition ` correspondiente al identificador de nodo de codificación binaria ` id`. Si se desconoce el identificador de nodo o este no pertenece a un tipo de estructura, se devuelve un valor construido por defecto.
QOpcUaStructureDefinition QOpcUaGenericStructHandler::structureDefinitionForTypeId(const QString &id) const
Devuelve el objeto ` QOpcUaStructureDefinition ` correspondiente al identificador de nodo de tipo ` id`. Si se desconoce el identificador de nodo o este no pertenece a un tipo de estructura, se devuelve un valor construido por defecto.
QString QOpcUaGenericStructHandler::typeIdForBinaryEncodingId(const QString &id) const
Devuelve el identificador del nodo de tipo asociado al identificador de codificación binaria id.
QString QOpcUaGenericStructHandler::typeNameForBinaryEncodingId(const QString &id) const
Devuelve el nombre del tipo correspondiente al identificador de nodo de codificación binaria id. Si se desconoce el identificador de nodo o este no pertenece a un tipo de estructura, se devuelve una cadena vacía.
QString QOpcUaGenericStructHandler::typeNameForTypeId(const QString &id) const
Devuelve el nombre del tipo correspondiente a un nodo de tipo de datos identificado por el identificador de nodo de tipo id. Si se desconoce el identificador del nodo, se devuelve una cadena vacía.
© 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.