QOpcUaReadItem Class

This class stores the options for a read operation. More...

Header: #include <QOpcUaReadItem>
CMake: find_package(Qt6 REQUIRED COMPONENTS OpcUa)
target_link_libraries(mytarget PRIVATE Qt6::OpcUa)
qmake: QT += opcua

Public Functions

QOpcUaReadItem(const QString &nodeId, QOpcUa::NodeAttribute attr = QOpcUa::NodeAttribute::Value, const QString &indexRange = QString())
QOpcUaReadItem(const QOpcUaReadItem &other)
QOpcUa::NodeAttribute attribute() const
QString indexRange() const
QString nodeId() const
void setAttribute(QOpcUa::NodeAttribute attribute)
void setIndexRange(const QString &indexRange)
void setNodeId(const QString &nodeId)
QOpcUaReadItem &operator=(const QOpcUaReadItem &rhs)
bool operator!=(const QOpcUaReadItem &lhs, const QOpcUaReadItem &rhs)
bool operator==(const QOpcUaReadItem &lhs, const QOpcUaReadItem &rhs)

Detailed Description

A read operation on an OPC UA server returns the entire value or a certain index range of the value of an attribute of a node on the server. This class contains the necessary information for the backend to make a read request to the server.

One or multiple objects of this class make up the request of a QOpcUaClient::readNodeAttributes() operation.

See also QOpcUaClient::readNodeAttributes() and QOpcUaReadResult.

Member Function Documentation

QOpcUaReadItem::QOpcUaReadItem(const QString &nodeId, QOpcUa::NodeAttribute attr = QOpcUa::NodeAttribute::Value, const QString &indexRange = QString())

Constructs a read item for the index range indexRange of the attribute attr of node nodeId.

QOpcUaReadItem::QOpcUaReadItem(const QOpcUaReadItem &other)

Constructs a read item from other.

QOpcUa::NodeAttribute QOpcUaReadItem::attribute() const

Returns the node attribute id.

See also setAttribute().

QString QOpcUaReadItem::indexRange() const

Returns the index range.

See also setIndexRange().

QString QOpcUaReadItem::nodeId() const

Returns the node id.

See also setNodeId().

void QOpcUaReadItem::setAttribute(QOpcUa::NodeAttribute attribute)

Sets the node attribute id to attribute.

See also attribute().

void QOpcUaReadItem::setIndexRange(const QString &indexRange)

Sets the index range to indexRange.

See also indexRange().

void QOpcUaReadItem::setNodeId(const QString &nodeId)

Sets the node id to nodeId.

See also nodeId().

QOpcUaReadItem &QOpcUaReadItem::operator=(const QOpcUaReadItem &rhs)

Sets the values from rhs in this read item.

Related Non-Members

bool operator!=(const QOpcUaReadItem &lhs, const QOpcUaReadItem &rhs)

Returns true if lhs is not equal to rhs; otherwise returns false.

Two read items are considered not equal if their nodeId, attribute or indexRange are not equal.

bool operator==(const QOpcUaReadItem &lhs, const QOpcUaReadItem &rhs)

Returns true if lhs is equal to rhs; otherwise returns false.

Two read items are considered equal if their nodeId, attribute, and indexRange are equal.

© 2024 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.