QOpcUaHistoryReadEventRequest Class
This class stores the necessary information to request historic data from a server. More...
| Header: | #include <QOpcUaHistoryReadEventRequest> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS OpcUa)target_link_libraries(mytarget PRIVATE Qt6::OpcUa) |
| qmake: | QT += opcua |
| Since: | Qt 6.7 |
Public Functions
| QOpcUaHistoryReadEventRequest() | |
| QOpcUaHistoryReadEventRequest(const QList<QOpcUaReadItem> &nodesToRead, const QDateTime &startTimestamp, const QDateTime &endTimestamp, const QOpcUaMonitoringParameters::EventFilter &filter) | |
| QOpcUaHistoryReadEventRequest(const QOpcUaHistoryReadEventRequest &other) | |
| QOpcUaHistoryReadEventRequest(QOpcUaHistoryReadEventRequest &&other) | |
| ~QOpcUaHistoryReadEventRequest() | |
| void | addNodeToRead(const QOpcUaReadItem &nodeToRead) |
| QDateTime | endTimestamp() const |
| QOpcUaMonitoringParameters::EventFilter | filter() const |
| QList<QOpcUaReadItem> | nodesToRead() const |
| quint32 | numValuesPerNode() const |
| void | setEndTimestamp(const QDateTime &endTimestamp) |
| void | setFilter(const QOpcUaMonitoringParameters::EventFilter &filter) |
| void | setNodesToRead(const QList<QOpcUaReadItem> &nodesToRead) |
| void | setNumValuesPerNode(quint32 numValuesPerNode) |
| void | setStartTimestamp(const QDateTime &startTimestamp) |
| QDateTime | startTimestamp() const |
| void | swap(QOpcUaHistoryReadEventRequest &other) |
| QOpcUaHistoryReadEventRequest & | operator=(QOpcUaHistoryReadEventRequest &&other) |
| QOpcUaHistoryReadEventRequest & | operator=(const QOpcUaHistoryReadEventRequest &other) |
Related Non-Members
| bool | operator!=(const QOpcUaHistoryReadEventRequest &lhs, const QOpcUaHistoryReadEventRequest &rhs) |
| bool | operator==(const QOpcUaHistoryReadEventRequest &lhs, const QOpcUaHistoryReadEventRequest &rhs) |
Detailed Description
This is the Qt OPC UA representation for the OPC UA ReadEventDetails for reading historical data defined in OPC-UA part 11, 6.4.2.
When requesting historic data from a server, several values need to be provided to the server to know which data to collect. The QOpcUaHistoryReadEventRequest class provides the required values. startTimestamp and endTimestamp define the timerange where historic events should be collected from. nodesToRead defines from which nodes historic data should be collected. numValuesPerNode defines the maximum number of events that should be returned per node. filter is the event filter used to determine which events and which of their fields to return.
Member Function Documentation
QOpcUaHistoryReadEventRequest::QOpcUaHistoryReadEventRequest()
Constructs an invalid QOpcUaHistoryReadEventRequest.
[explicit] QOpcUaHistoryReadEventRequest::QOpcUaHistoryReadEventRequest(const QList<QOpcUaReadItem> &nodesToRead, const QDateTime &startTimestamp, const QDateTime &endTimestamp, const QOpcUaMonitoringParameters::EventFilter &filter)
Constructs a QOpcUaHistoryReadEventRequest item with the given values.
QOpcUaHistoryReadEventRequest::QOpcUaHistoryReadEventRequest(const QOpcUaHistoryReadEventRequest &other)
Constructs a QOpcUaHistoryReadEventRequest item from other.
[noexcept] QOpcUaHistoryReadEventRequest::QOpcUaHistoryReadEventRequest(QOpcUaHistoryReadEventRequest &&other)
Move-constructs a new read event request object from other.
Note: The moved-from object other is placed in a partially-formed state, in which the only valid operations are destruction and assignment of a new value.
[noexcept] QOpcUaHistoryReadEventRequest::~QOpcUaHistoryReadEventRequest()
Destroys the request object.
void QOpcUaHistoryReadEventRequest::addNodeToRead(const QOpcUaReadItem &nodeToRead)
Adds a node to the nodeToRead list.
QDateTime QOpcUaHistoryReadEventRequest::endTimestamp() const
Returns the end time stamp.
See also setEndTimestamp().
QOpcUaMonitoringParameters::EventFilter QOpcUaHistoryReadEventRequest::filter() const
Returns the event filter used to retrieve historical events.
See also setFilter().
QList<QOpcUaReadItem> QOpcUaHistoryReadEventRequest::nodesToRead() const
Returns the list of nodes to read.
See also setNodesToRead().
quint32 QOpcUaHistoryReadEventRequest::numValuesPerNode() const
Returns the number of values per node.
See also setNumValuesPerNode().
void QOpcUaHistoryReadEventRequest::setEndTimestamp(const QDateTime &endTimestamp)
Sets endTimestamp for the historical data to be fetched.
See also endTimestamp().
void QOpcUaHistoryReadEventRequest::setFilter(const QOpcUaMonitoringParameters::EventFilter &filter)
Sets the event filter used to retrieve historical events to filter.
See also filter().
void QOpcUaHistoryReadEventRequest::setNodesToRead(const QList<QOpcUaReadItem> &nodesToRead)
Sets the nodesToRead list.
See also nodesToRead().
void QOpcUaHistoryReadEventRequest::setNumValuesPerNode(quint32 numValuesPerNode)
Sets numValuesPerNode to indicate the number of values per node to be fetched.
See also numValuesPerNode().
void QOpcUaHistoryReadEventRequest::setStartTimestamp(const QDateTime &startTimestamp)
Sets startTimestamp for the historical data to be fetched.
See also startTimestamp().
QDateTime QOpcUaHistoryReadEventRequest::startTimestamp() const
Returns the start time stamp.
See also setStartTimestamp().
[noexcept] void QOpcUaHistoryReadEventRequest::swap(QOpcUaHistoryReadEventRequest &other)
Swaps read event request object other with this read event request object. This operation is very fast and never fails.
[noexcept] QOpcUaHistoryReadEventRequest &QOpcUaHistoryReadEventRequest::operator=(QOpcUaHistoryReadEventRequest &&other)
Move-assigns other to this QOpcUaHistoryReadEventRequest instance.
Note: The moved-from object other is placed in a partially-formed state, in which the only valid operations are destruction and assignment of a new value.
QOpcUaHistoryReadEventRequest &QOpcUaHistoryReadEventRequest::operator=(const QOpcUaHistoryReadEventRequest &other)
Sets the values from other in this QOpcUaHistoryReadEventRequest item.
Related Non-Members
[noexcept] bool operator!=(const QOpcUaHistoryReadEventRequest &lhs, const QOpcUaHistoryReadEventRequest &rhs)
Returns true if lhs is not equal to rhs; otherwise returns false.
Two QOpcUaHistoryReadEventRequest items are considered not equal if their startTimestamp, endTimestamp, numValuesPerNode, filter or nodesToRead are not equal.
[noexcept] bool operator==(const QOpcUaHistoryReadEventRequest &lhs, const QOpcUaHistoryReadEventRequest &rhs)
Returns true if lhs is equal to rhs; otherwise returns false.
Two QOpcUaHistoryReadEventRequest items are considered equal if their startTimestamp, endTimestamp, numValuesPerNode, filter and nodesToRead are equal.