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
166
167
168
169
170
171
172
173
174
175
176
|
/****************************************************************************
**
** 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 QOPCUACLIENT_H
#define QOPCUACLIENT_H
#include <QtOpcUa/qopcuaglobal.h>
#include <QtOpcUa/qopcuaapplicationidentity.h>
#include <QtOpcUa/qopcuapkiconfiguration.h>
#include <QtOpcUa/qopcuanode.h>
#include <QtOpcUa/qopcuareaditem.h>
#include <QtOpcUa/qopcuareadresult.h>
#include <QtOpcUa/qopcuawriteitem.h>
#include <QtOpcUa/qopcuawriteresult.h>
#include <QtOpcUa/qopcuaaddnodeitem.h>
#include <QtOpcUa/qopcuaaddreferenceitem.h>
#include <QtOpcUa/qopcuadeletereferenceitem.h>
#include <QtOpcUa/qopcuaendpointdescription.h>
#include <QtOpcUa/qopcuahistoryreadrawrequest.h>
#include <QtCore/qobject.h>
#include <QtCore/qurl.h>
QT_BEGIN_NAMESPACE
class QOpcUaAuthenticationInformation;
class QOpcUaApplicationDescription;
class QOpcUaClientPrivate;
class QOpcUaClientImpl;
class QOpcUaErrorState;
class QOpcUaExpandedNodeId;
class QOpcUaQualifiedName;
class QOpcUaEndpointDescription;
class Q_OPCUA_EXPORT QOpcUaClient : public QObject
{
Q_OBJECT
Q_PROPERTY(ClientState state READ state NOTIFY stateChanged)
Q_PROPERTY(ClientError error READ error NOTIFY errorChanged)
Q_DECLARE_PRIVATE(QOpcUaClient)
public:
enum ClientState {
Disconnected,
Connecting,
Connected,
Closing
};
Q_ENUM(ClientState)
enum ClientError {
NoError,
InvalidUrl,
AccessDenied,
ConnectionError,
UnknownError,
UnsupportedAuthenticationInformation
};
Q_ENUM(ClientError)
explicit QOpcUaClient(QOpcUaClientImpl *impl, QObject *parent = nullptr);
~QOpcUaClient();
void setApplicationIdentity(const QOpcUaApplicationIdentity &identity);
QOpcUaApplicationIdentity applicationIdentity() const;
void setPkiConfiguration(const QOpcUaPkiConfiguration &config);
QOpcUaPkiConfiguration pkiConfiguration() const;
Q_INVOKABLE void connectToEndpoint(const QOpcUaEndpointDescription &endpoint);
Q_INVOKABLE void disconnectFromEndpoint();
QOpcUaNode *node(const QString &nodeId);
QOpcUaNode *node(const QOpcUaExpandedNodeId &expandedNodeId);
bool updateNamespaceArray();
QStringList namespaceArray() const;
QString resolveExpandedNodeId(const QOpcUaExpandedNodeId &expandedNodeId, bool *ok = nullptr) const;
QOpcUaQualifiedName qualifiedNameFromNamespaceUri(const QString &namespaceUri, const QString &name, bool *ok = nullptr) const;
bool requestEndpoints(const QUrl &url);
bool findServers(const QUrl &url, const QStringList &localeIds = QStringList(),
const QStringList &serverUris = QStringList());
bool readNodeAttributes(const QList<QOpcUaReadItem> &nodesToRead);
bool writeNodeAttributes(const QList<QOpcUaWriteItem> &nodesToWrite);
bool addNode(const QOpcUaAddNodeItem &nodeToAdd);
bool deleteNode(const QString &nodeId, bool deleteTargetReferences = true);
bool addReference(const QOpcUaAddReferenceItem &referenceToAdd);
bool deleteReference(const QOpcUaDeleteReferenceItem &referenceToDelete);
QOpcUaEndpointDescription endpoint() const;
ClientState state() const;
ClientError error() const;
QString backend() const;
void setNamespaceAutoupdate(bool isEnabled);
bool isNamespaceAutoupdateEnabled() const;
void setNamespaceAutoupdateInterval(int interval);
int namespaceAutoupdateInterval() const;
void setAuthenticationInformation(const QOpcUaAuthenticationInformation &authenticationInformation);
const QOpcUaAuthenticationInformation &authenticationInformation() const;
QStringList supportedSecurityPolicies() const;
QList<QOpcUaUserTokenPolicy::TokenType> supportedUserTokenTypes() const;
QOpcUaHistoryReadResponse *readHistoryData(const QOpcUaHistoryReadRawRequest &request);
Q_SIGNALS:
void connected();
void disconnected();
void stateChanged(QOpcUaClient::ClientState state);
void errorChanged(QOpcUaClient::ClientError error);
void connectError(QOpcUaErrorState *errorState);
void namespaceArrayUpdated(QStringList namespaces);
void namespaceArrayChanged(QStringList namespaces);
void endpointsRequestFinished(QList<QOpcUaEndpointDescription> endpoints, QOpcUa::UaStatusCode statusCode, QUrl requestUrl);
void findServersFinished(QList<QOpcUaApplicationDescription> servers, QOpcUa::UaStatusCode statusCode, QUrl requestUrl);
void readNodeAttributesFinished(QList<QOpcUaReadResult> results, QOpcUa::UaStatusCode serviceResult);
void writeNodeAttributesFinished(QList<QOpcUaWriteResult> results, QOpcUa::UaStatusCode serviceResult);
void addNodeFinished(QOpcUaExpandedNodeId requestedNodeId, QString assignedNodeId, QOpcUa::UaStatusCode statusCode);
void deleteNodeFinished(QString nodeId, QOpcUa::UaStatusCode statusCode);
void addReferenceFinished(QString sourceNodeId, QString referenceTypeId, QOpcUaExpandedNodeId targetNodeId, bool isForwardReference,
QOpcUa::UaStatusCode statusCode);
void deleteReferenceFinished(QString sourceNodeId, QString referenceTypeId, QOpcUaExpandedNodeId targetNodeId, bool isForwardReference,
QOpcUa::UaStatusCode statusCode);
void passwordForPrivateKeyRequired(QString keyFilePath, QString *password, bool previousTryWasInvalid);
private:
Q_DISABLE_COPY(QOpcUaClient)
};
QT_END_NAMESPACE
Q_DECLARE_METATYPE(QOpcUaClient::ClientState)
Q_DECLARE_METATYPE(QOpcUaClient::ClientError)
#endif // QOPCUACLIENT_H
|
