summaryrefslogtreecommitdiffstats
path: root/src/opcua/client/qopcuanode.h
blob: b2e3d1363ca851fe030681b5594eb6667fcd39df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/****************************************************************************
**
** Copyright (C) 2015 basysKom GmbH, opensource@basyskom.com
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtOpcUa module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QOPCUANODE_H
#define QOPCUANODE_H

#include <QtOpcUa/qopcuaglobal.h>
#include <QtOpcUa/qopcuatype.h>

#include <QtCore/qdatetime.h>
#include <QtCore/qdebug.h>
#include <QtCore/qvariant.h>
#include <QtCore/qobject.h>

QT_BEGIN_NAMESPACE

class QOpcUaNodePrivate;
class QOpcUaNodeImpl;
class QOpcUaClient;
class QOpcUaMonitoredEvent;
class QOpcUaMonitoredValue;

class Q_OPCUA_EXPORT QOpcUaNode : public QObject
{
    Q_OBJECT

public:
    Q_DECLARE_PRIVATE(QOpcUaNode)

    // see OPC-UA Part 3, 5.2.3 & 8.30
    enum class NodeClass {
        Undefined = 0,
        Object = 1,
        Variable = 2,
        Method = 4,
        ObjectType = 8,
        VariableType = 16,
        ReferenceType = 32,
        DataType = 64,
        View = 128,
    };
    Q_ENUM(NodeClass)

    enum class NodeAttribute {
        None = 0,
        NodeId = (1 << 0),
        NodeClass = (1 << 1),
        BrowseName = (1 << 2),
        DisplayName = (1 << 3),
        Description = (1 << 4),
        WriteMask = (1 << 5),
        UserWriteMask = (1 << 6), // Base attributes, see part 4, 5.2.1
        IsAbstract = (1 << 7),
        Symmetric = (1 << 8),
        InverseName = (1 << 9),   // Reference attributes, see part 4, 5.3.1
        ContainsNoLoops = (1 << 10),
        EventNotifier = (1 << 11), // View attributes, see part 4, 5.4
        // Objects also add the EventNotifier attribute, see part 4, 5.5.1
        // ObjectType also add the IsAbstract attribute, see part 4, 5.5.2
        Value = (1 << 12),
        DataType = (1 << 13),
        ValueRank = (1 << 14),
        ArrayDimensions = (1 << 15),
        AccessLevel = (1 << 16),
        UserAccessLevel = (1 << 17),
        MinimumSamplingInterval = (1 << 18),
        Historizing = (1 << 19),   // Value attributes, see part 4, 5.6.2
        // VariableType also adds the Value, DataType, ValueRank, ArrayDimensions
        // and isAbstract attributes, see part 4, 5.6.5
        Executable = (1 << 20),
        UserExecutable = (1 << 21), // Method attributes, see part 4, 5.7
    };
    Q_ENUM(NodeAttribute)
    Q_DECLARE_FLAGS(NodeAttributes, NodeAttribute)

    static Q_DECL_CONSTEXPR QOpcUaNode::NodeAttributes mandatoryBaseAttributes();
    static Q_DECL_CONSTEXPR QOpcUaNode::NodeAttributes allBaseAttributes();
    typedef QMap<QOpcUaNode::NodeAttribute, QVariant> AttributeMap;

    QOpcUaNode(QOpcUaNodeImpl *impl, QOpcUaClient *client, QObject *parent = nullptr);
    virtual ~QOpcUaNode();

    bool readAttributes(QOpcUaNode::NodeAttributes attributes = mandatoryBaseAttributes());
    QVariant attribute(QOpcUaNode::NodeAttribute attribute) const;
    QOpcUa::UaStatusCode attributeError(QOpcUaNode::NodeAttribute attribute) const;
    bool writeAttribute(QOpcUaNode::NodeAttribute attribute, const QVariant &value, QOpcUa::Types type = QOpcUa::Types::Undefined);
    bool writeAttributes(const AttributeMap &toWrite, QOpcUa::Types valueAttributeType = QOpcUa::Types::Undefined);

    QStringList childrenIds() const;
    QString nodeId() const;

    QPair<double, double> readEuRange() const;
    QPair<QString, QString> readEui() const;

    bool call(const QString &methodNodeId, QVector<QOpcUa::TypedVariant> *args = nullptr,
              QVector<QVariant> *ret = nullptr);

Q_SIGNALS:
    void readFinished(QOpcUaNode::NodeAttributes attributes);
    void attributeWritten(QOpcUaNode::NodeAttribute attribute, QOpcUa::UaStatusCode statusCode);

private:
    Q_DISABLE_COPY(QOpcUaNode)
};

Q_OPCUA_EXPORT QDebug operator<<(QDebug dbg, const QOpcUaNode &node);

Q_DECLARE_TYPEINFO(QOpcUaNode::NodeClass, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(QOpcUaNode::NodeAttribute, Q_PRIMITIVE_TYPE);
Q_DECLARE_OPERATORS_FOR_FLAGS(QOpcUaNode::NodeAttributes)

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QOpcUaNode::NodeClass)
Q_DECLARE_METATYPE(QOpcUaNode::NodeAttribute)
Q_DECLARE_METATYPE(QOpcUaNode::NodeAttributes)
Q_DECLARE_METATYPE(QOpcUaNode::AttributeMap)

inline Q_DECL_CONSTEXPR QOpcUaNode::NodeAttributes QOpcUaNode::mandatoryBaseAttributes()
{
    return QOpcUaNode::NodeAttribute::NodeId | QOpcUaNode::NodeAttribute::NodeClass |
            QOpcUaNode::NodeAttribute::BrowseName | QOpcUaNode::NodeAttribute::DisplayName;
}

inline Q_DECL_CONSTEXPR QOpcUaNode::NodeAttributes QOpcUaNode::allBaseAttributes()
{
    return NodeAttribute::NodeId | NodeAttribute::NodeClass | NodeAttribute::BrowseName |
            NodeAttribute::DisplayName | NodeAttribute::Description | NodeAttribute::WriteMask |
            NodeAttribute::UserWriteMask;
}

#endif // QOPCUANODE_H