QOpcUaBinaryDataEncoding Class
QOpcUaBinaryDataEncoding is a partial implementation of the OPC UA binary data encoding described in OPC UA part 6. More...
| Header: | #include <QOpcUaBinaryDataEncoding> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS OpcUa)target_link_libraries(mytarget PRIVATE Qt6::OpcUa) |
| qmake: | QT += opcua |
Public Functions
| QOpcUaBinaryDataEncoding(QByteArray *buffer) | |
| QOpcUaBinaryDataEncoding(QOpcUaExtensionObject &object) | |
| T | decode(bool &success) |
| QList<T> | decodeArray(bool &success) |
| bool | encode(const T &src) |
| bool | encodeArray(const QList<T> &src) |
| int | offset() const |
| void | setOffset(int offset) |
| void | truncateBufferToOffset() |
Detailed Description
It offers template functions for encoding and decoding data for reading and writing extension objects.
The following types are supported:
| Qt type | OPC UA type |
|---|---|
| quint8 | uint8 |
| qint8 | int8 |
| quint16 | uint16 |
| qint16 | int16 |
| quint32 | uint32 |
| qint32 | int32 |
| quint64 | uint64 |
| qint64 | int64 |
| float | float |
| double | double |
| QString | String |
| QOpcUaQualifiedName | QualifiedName |
| QOpcUaLocalizedText | LocalizedText |
| QOpcUaEUInformation | EUInformation |
| QOpcUaRange | Range |
| QOpcUaComplexNumber | ComplexNumber |
| QOpcUaDoubleComplexNumber | DoubleComplexNumber |
| QOpcUaAxisInformation | AxisInformation |
| QOpcUaXValue | XV |
| QUuid | GUID |
| QString node id | NodeId |
| QByteArray | ByteString |
| QDateTime | DateTime |
| QOpcUa::UaStatusCode | StatusCode |
| QOpcUaExpandedNodeId | ExpandedNodeId |
| QOpcUaExtensionObject | ExtensionObject |
| QOpcUaArgument | Argument |
| QOpcUaDiagnosticInfo (since Qt 6.7) | DiagnosticInfo |
| QOpcUaApplicationRecordDataType | ApplicationRecordDataType |
| QOpcUaStructureDefinition (since Qt 6.7) | StructureDefintion |
| QOpcUaStructureField (since Qt 6.7) | StructureField |
| QOpcUaEnumDefinition (since Qt 6.7) | EnumDefintion |
| QOpcUaEnumField (since Qt 6.7) | EnumField |
| QOpcUaVariant (since Qt 6.7) | Variant |
| QOpcUaDataValue (since Qt 6.7) | DataValue |
Member Function Documentation
QOpcUaBinaryDataEncoding::QOpcUaBinaryDataEncoding(QByteArray *buffer)
Constructs a binary data encoding object for the data buffer buffer. buffer must not be deleted as long as this binary data encoding object is used.
QOpcUaBinaryDataEncoding::QOpcUaBinaryDataEncoding(QOpcUaExtensionObject &object)
Constructs a binary data encoding object using the encoded body of object as data buffer.
object must not be deleted as long as this binary data encoding object is used.
template <typename T, QOpcUa::Types OVERLAY = QOpcUa::Types::Undefined> T QOpcUaBinaryDataEncoding::decode(bool &success)
Decodes a scalar value of type T from the data buffer. success is set to true if the decoding was successful, false if not.
The decoded value is returned. If success is false, the returned value is invalid.
See also decodeArray().
template <typename T, QOpcUa::Types OVERLAY = QOpcUa::Types::Undefined> QList<T> QOpcUaBinaryDataEncoding::decodeArray(bool &success)
Decodes an array of type T from the data buffer. success is set to true if the decoding was successful, false if not.
The decoded value is returned. If success is false, the returned value is invalid.
See also decode().
template <typename T, QOpcUa::Types OVERLAY = QOpcUa::Types::Undefined> bool QOpcUaBinaryDataEncoding::encode(const T &src)
Encodes src of type T and appends the encoded value to the data buffer. Returns true if the value has been successfully encoded.
See also encodeArray().
template <typename T, QOpcUa::Types OVERLAY = QOpcUa::Types::Undefined> bool QOpcUaBinaryDataEncoding::encodeArray(const QList<T> &src)
Encodes all elements of type T in src and appends the encoded values to the data buffer.
Returns true if the value has been successfully encoded.
See also encode().
int QOpcUaBinaryDataEncoding::offset() const
Returns the current offset in the data buffer.
See also setOffset().
void QOpcUaBinaryDataEncoding::setOffset(int offset)
Sets the current offset in the data buffer to offset. The first byte in the buffer has the offset 0.
See also offset().
void QOpcUaBinaryDataEncoding::truncateBufferToOffset()
Truncates the data buffer to the current offset(). If the offset is behind the current buffer size, this method does nothing.
This method can be used to roll back after an unsuccessful encode by setting the old offset and calling truncateBufferToOffset().