Source code
Revision control
Copy as Markdown
// Copyright (C) 2015 basysKom GmbH, opensource@basyskom.com
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#ifndef QOPCUANODE_H
#define QOPCUANODE_H
#include <QtOpcUa/qopcuabrowserequest.h>
#include <QtOpcUa/qopcuaglobal.h>
#include <QtOpcUa/qopcuamonitoringparameters.h>
#include <QtOpcUa/qopcuareferencedescription.h>
#include <QtOpcUa/qopcuatype.h>
#include <QtOpcUa/qopcuabrowsepathtarget.h>
#include <QtOpcUa/qopcuarelativepathelement.h>
#include <QtCore/qdatetime.h>
#include <QtCore/qdebug.h>
#include <QtCore/qvariant.h>
#include <QtCore/qobject.h>
#include <QtCore/qmap.h>
QT_BEGIN_NAMESPACE
class QOpcUaNodePrivate;
class QOpcUaNodeImpl;
class QOpcUaClient;
class QOpcUaHistoryReadRawRequest;
class QOpcUaHistoryReadResponse;
class Q_OPCUA_EXPORT QOpcUaNode : public QObject
{
Q_OBJECT
public:
Q_DECLARE_PRIVATE(QOpcUaNode)
static Q_DECL_CONSTEXPR QOpcUa::NodeAttributes mandatoryBaseAttributes();
static Q_DECL_CONSTEXPR QOpcUa::NodeAttributes allBaseAttributes();
typedef QMap<QOpcUa::NodeAttribute, QVariant> AttributeMap;
QOpcUaNode(QOpcUaNodeImpl *impl, QOpcUaClient *client, QObject *parent = nullptr);
virtual ~QOpcUaNode();
bool readAttributes(QOpcUa::NodeAttributes attributes = mandatoryBaseAttributes());
bool readAttributeRange(QOpcUa::NodeAttribute attribute, const QString &indexRange);
bool readValueAttribute();
QVariant attribute(QOpcUa::NodeAttribute attribute) const;
QVariant valueAttribute() const;
QOpcUa::UaStatusCode attributeError(QOpcUa::NodeAttribute attribute) const;
QOpcUa::UaStatusCode valueAttributeError() const;
QDateTime sourceTimestamp(QOpcUa::NodeAttribute attribute) const;
QDateTime serverTimestamp(QOpcUa::NodeAttribute attribute) const;
bool writeAttribute(QOpcUa::NodeAttribute attribute, const QVariant &value, QOpcUa::Types type = QOpcUa::Types::Undefined);
bool writeAttributeRange(QOpcUa::NodeAttribute attribute, const QVariant &value,
const QString &indexRange, QOpcUa::Types type = QOpcUa::Types::Undefined);
bool writeAttributes(const AttributeMap &toWrite, QOpcUa::Types valueAttributeType = QOpcUa::Types::Undefined);
bool writeValueAttribute(const QVariant &value, QOpcUa::Types type = QOpcUa::Types::Undefined);
bool enableMonitoring(QOpcUa::NodeAttributes attr, const QOpcUaMonitoringParameters &settings);
bool disableMonitoring(QOpcUa::NodeAttributes attr);
bool modifyMonitoring(QOpcUa::NodeAttribute attr, QOpcUaMonitoringParameters::Parameter item, const QVariant &value);
QOpcUaMonitoringParameters monitoringStatus(QOpcUa::NodeAttribute attr);
bool modifyEventFilter(const QOpcUaMonitoringParameters::EventFilter &eventFilter);
bool modifyDataChangeFilter(QOpcUa::NodeAttribute attr, const QOpcUaMonitoringParameters::DataChangeFilter &filter);
bool browseChildren(QOpcUa::ReferenceTypeId referenceType = QOpcUa::ReferenceTypeId::HierarchicalReferences,
QOpcUa::NodeClasses nodeClassMask = QOpcUa::NodeClass::Undefined);
QString nodeId() const;
QOpcUaClient *client() const;
bool callMethod(const QString &methodNodeId, const QList<QOpcUa::TypedVariant> &args = QList<QOpcUa::TypedVariant>());
bool resolveBrowsePath(const QList<QOpcUaRelativePathElement> &path);
bool browse(const QOpcUaBrowseRequest &request);
QOpcUaHistoryReadResponse *readHistoryRaw(const QDateTime &startTime, const QDateTime &endTime, quint32 numValues, bool returnBounds);
QOpcUaHistoryReadResponse *readHistoryRaw(const QDateTime &startTime, const QDateTime &endTime, quint32 numValues, bool returnBounds, QOpcUa::TimestampsToReturn timestampsToReturn);
QOpcUaHistoryReadResponse *readHistoryEvents(const QDateTime &startTime, const QDateTime &endTime,
QOpcUaMonitoringParameters::EventFilter &filter, quint32 numValues = 0);
Q_SIGNALS:
void attributeRead(QOpcUa::NodeAttributes attributes);
void attributeWritten(QOpcUa::NodeAttribute attribute, QOpcUa::UaStatusCode statusCode);
void dataChangeOccurred(QOpcUa::NodeAttribute attr, QVariant value);
void attributeUpdated(QOpcUa::NodeAttribute attr, QVariant value);
void valueAttributeUpdated(const QVariant &value);
void eventOccurred(QVariantList eventFields);
void monitoringStatusChanged(QOpcUa::NodeAttribute attr, QOpcUaMonitoringParameters::Parameters items,
QOpcUa::UaStatusCode statusCode);
void enableMonitoringFinished(QOpcUa::NodeAttribute attr, QOpcUa::UaStatusCode statusCode);
void disableMonitoringFinished(QOpcUa::NodeAttribute attr, QOpcUa::UaStatusCode statusCode);
void methodCallFinished(QString methodNodeId, QVariant result, QOpcUa::UaStatusCode statusCode);
void browseFinished(QList<QOpcUaReferenceDescription> children, QOpcUa::UaStatusCode statusCode);
void resolveBrowsePathFinished(QList<QOpcUaBrowsePathTarget> targets,
QList<QOpcUaRelativePathElement> path, QOpcUa::UaStatusCode statusCode);
private:
Q_DISABLE_COPY(QOpcUaNode)
};
Q_OPCUA_EXPORT QDebug operator<<(QDebug dbg, const QOpcUaNode &node);
QT_END_NAMESPACE
Q_DECLARE_METATYPE(QOpcUaNode::AttributeMap)
inline Q_DECL_CONSTEXPR QOpcUa::NodeAttributes QOpcUaNode::mandatoryBaseAttributes()
{
return QOpcUa::NodeAttribute::NodeId | QOpcUa::NodeAttribute::NodeClass |
QOpcUa::NodeAttribute::BrowseName | QOpcUa::NodeAttribute::DisplayName;
}
inline Q_DECL_CONSTEXPR QOpcUa::NodeAttributes QOpcUaNode::allBaseAttributes()
{
return QOpcUa::NodeAttribute::NodeId | QOpcUa::NodeAttribute::NodeClass | QOpcUa::NodeAttribute::BrowseName |
QOpcUa::NodeAttribute::DisplayName | QOpcUa::NodeAttribute::Description | QOpcUa::NodeAttribute::WriteMask |
QOpcUa::NodeAttribute::UserWriteMask | QOpcUa::NodeAttribute::RolePermissions |
QOpcUa::NodeAttribute::UserRolePermissions | QOpcUa::NodeAttribute::AccessRestrictions;
}
#endif // QOPCUANODE_H