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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/****************************************************************************
**
** 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$
**
****************************************************************************/
#include "qopcuaplugin.h"
#include "qopcuaprovider.h"
#include <QtOpcUa/qopcuaclient.h>
#include <QtOpcUa/qopcuanode.h>
#include <QtOpcUa/qopcuatype.h>
#include <private/qopcuanodeimpl_p.h>
#include <private/qfactoryloader_p.h>
#include <QtCore/qjsonarray.h>
#include <QtCore/qloggingcategory.h>
#include <QtCore/qpluginloader.h>
QT_BEGIN_NAMESPACE
Q_LOGGING_CATEGORY(QT_OPCUA, "qt.opcua")
/*!
\class QOpcUaProvider
\inmodule QtOpcUa
\brief QOpcUaProvider creates an instance of QOpcUaClient.
QOpcUaProvider allows the user to create an instance of QOpcUaClient by
loading a QOpcUaPlugin using the Qt plugin system.
For the available plugins and their capabilities please refer to the
\l {Qt OPC UA} {introduction}.
\section1 Example
This code creates a client using the first available backend:
\code
QOpcUaProvider provider;
QStringList available = provider.availableBackends();
if (!available.isEmpty()) {
QOpcUaClient *client = provider.createClient(available[0]);
if (client)
qDebug() << "Client successfully created";
}
\endcode
*/
Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, qOpcualoader,
(QOpcUaProviderFactory_iid, QLatin1String("/opcua")))
/*!
\fn static QHash<QString, QJsonObject> loadPluginMetadata()
Reads the meta data from the plugins known by the loader.
*/
static QHash<QString, QJsonObject> loadPluginMetadata()
{
QHash<QString, QJsonObject> plugins;
const QFactoryLoader *l = qOpcualoader();
QList<QJsonObject> const meta = l->metaData();
for (int i = 0; i < meta.size(); ++i) {
QJsonObject obj = meta.at(i).value(QStringLiteral("MetaData")).toObject();
obj.insert(QStringLiteral("index"), i);
plugins.insertMulti(obj.value(QStringLiteral("Provider")).toString(), obj);
}
return plugins;
}
/*!
\fn static QHash<QString, QJsonObject> plugins()
Returns a \l QHash mapping names to JSON objects containing the meta data of
available plugins.
*/
static QHash<QString, QJsonObject> plugins()
{
static QHash<QString, QJsonObject> plugins;
static bool alreadyDiscovered = false;
if (!alreadyDiscovered) {
plugins = loadPluginMetadata();
alreadyDiscovered = true;
}
return plugins;
}
/*!
Creates a new OPC UA provider with a given \a parent.
*/
QOpcUaProvider::QOpcUaProvider(QObject *parent)
: QObject(parent)
{
qRegisterMetaType<QOpcUa::Types>();
qRegisterMetaType<QOpcUa::TypedVariant>();
qRegisterMetaType<QVector<QOpcUa::TypedVariant>>();
qRegisterMetaType<QOpcUa::UaStatusCode>();
qRegisterMetaType<QOpcUa::NodeClass>();
qRegisterMetaType<QOpcUa::NodeClasses>();
qRegisterMetaType<QOpcUa::QQualifiedName>();
qRegisterMetaType<QOpcUa::NodeAttribute>();
qRegisterMetaType<QOpcUa::NodeAttributes>();
qRegisterMetaType<QOpcUaNode::AttributeMap>();
qRegisterMetaType<QVector<QOpcUaReadResult>>();
qRegisterMetaType<QOpcUaClient::ClientState>();
qRegisterMetaType<QOpcUaClient::ClientError>();
qRegisterMetaType<QOpcUa::ReferenceTypeId>();
qRegisterMetaType<QOpcUaMonitoringParameters::SubscriptionType>();
qRegisterMetaType<QOpcUaMonitoringParameters::Parameter>();
qRegisterMetaType<QOpcUaMonitoringParameters::Parameters>();
qRegisterMetaType<QOpcUaMonitoringParameters>();
qRegisterMetaType<QOpcUaReferenceDescription>();
qRegisterMetaType<QVector<QOpcUaReferenceDescription>>();
qRegisterMetaType<QOpcUa::ReferenceTypeId>();
qRegisterMetaType<QOpcUa::QRange>();
qRegisterMetaType<QOpcUa::QEUInformation>();
qRegisterMetaType<QOpcUa::QComplexNumber>();
qRegisterMetaType<QOpcUa::QDoubleComplexNumber>();
qRegisterMetaType<QOpcUa::QAxisInformation>();
qRegisterMetaType<QOpcUa::QXValue>();
qRegisterMetaType<QOpcUa::QExpandedNodeId>();
qRegisterMetaType<QOpcUa::QRelativePathElement>();
qRegisterMetaType<QVector<QOpcUa::QRelativePathElement>>();
qRegisterMetaType<QOpcUa::QBrowsePathTarget>();
qRegisterMetaType<QVector<QOpcUa::QBrowsePathTarget>>();
qRegisterMetaType<QOpcUa::QEndpointDescription>();
qRegisterMetaType<QVector<QOpcUa::QEndpointDescription>>();
qRegisterMetaType<QOpcUa::QArgument>();
qRegisterMetaType<QOpcUa::QExtensionObject>();
qRegisterMetaType<QOpcUaBrowseRequest>();
qRegisterMetaType<QOpcUaReadItem>();
qRegisterMetaType<QOpcUaReadResult>();
qRegisterMetaType<QVector<QOpcUaReadItem>>();
qRegisterMetaType<QVector<QOpcUaReadResult>>();
qRegisterMetaType<QOpcUaWriteItem>();
qRegisterMetaType<QOpcUaWriteResult>();
qRegisterMetaType<QVector<QOpcUaWriteItem>>();
qRegisterMetaType<QVector<QOpcUaWriteResult>>();
qRegisterMetaType<QOpcUaNodeCreationAttributes>();
qRegisterMetaType<QOpcUaAddNodeItem>();
qRegisterMetaType<QOpcUaAddReferenceItem>();
qRegisterMetaType<QOpcUaDeleteReferenceItem>();
}
QOpcUaProvider::~QOpcUaProvider()
{
qDeleteAll(m_plugins);
}
static QOpcUaPlugin *loadPlugin(const QString &key)
{
const int index = qOpcualoader()->indexOf(key);
if (index != -1) {
QObject *factoryObject = qOpcualoader()->instance(index);
if (QOpcUaPlugin *plugin = qobject_cast<QOpcUaPlugin *>(factoryObject)) {
return plugin;
}
}
return nullptr;
}
/*!
Returns a pointer to a QOpcUaClient object by loading the selected \a backend
as a plugin and creating a client object.
If the plugin loading fails, \c nullptr is returned instead.
The user is responsible for deleting the returned \l QOpcUaClient object
when it is no longer needed.
*/
QOpcUaClient *QOpcUaProvider::createClient(const QString &backend)
{
QOpcUaPlugin *plugin;
auto it = m_plugins.find(backend);
if (it == m_plugins.end()) {
plugin = loadPlugin(backend);
if (!plugin) {
qCWarning(QT_OPCUA) << "Failed to load OPC UA plugin:" << backend;
qCWarning(QT_OPCUA) << "Available plugins:" << availableBackends();
return nullptr;
}
m_plugins.insert(backend, plugin);
}
else {
plugin = it.value();
}
return plugin->createClient();
}
/*!
Returns a QStringList of available plugins.
*/
QStringList QOpcUaProvider::availableBackends()
{
return plugins().keys();
}
QT_END_NAMESPACE
|
