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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/******************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtKnx module.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
******************************************************************************/
#include "qknxnetipservicefamiliesdib.h"
#include <algorithm>
QT_BEGIN_NAMESPACE
/*!
\inmodule QtKnx
\class QKnxServiceInfo
\ingroup qtknx-netip
\brief The QKnxServiceInfo class contains the supported service and the
corresponding service family version.
The service family is the high octet of the service type ID and the service
family version is an integer representing the service family version. It
refers to the version of the corresponding KNXnet/IP document, not to the
manufacturer's implemented version.
\sa QKnxNetIpServiceFamiliesDibProxy, {Qt KNXnet/IP Connection Classes}
*/
/*!
\variable QKnxServiceInfo::ServiceFamily
The service family is the high octet of the service type ID.
\sa QKnx::NetIp::ServiceType, QKnx::NetIp::ServiceFamily
*/
/*!
\variable QKnxServiceInfo::ServiceFamilyVersion
The service family version is an integer representing the service family
version. It refers to the version of the corresponding KNXnet/IP document,
not to the manufacturer's implemented version.
*/
/*!
\since 5.13
Returns \c true if this object and the given \a other are equal; otherwise
returns \c false.
*/
bool QKnxServiceInfo::operator==(const QKnxServiceInfo &other) const
{
return ServiceFamily == other.ServiceFamily && ServiceFamilyVersion == other.ServiceFamilyVersion;
}
/*!
\since 5.13
Returns \c true if this object and the given \a other are not equal;
otherwise returns \c false.
*/
bool QKnxServiceInfo::operator!=(const QKnxServiceInfo &other) const
{
return !operator==(other);
}
/*!
\class QKnxNetIpServiceFamiliesDibProxy
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpServiceFamiliesDibProxy class provides the means to read
the supported service families and versions from the generic \l QKnxNetIpDib
class and to create a KNXnet/IP device information block (DIB) structure
based on the information.
A KNXnet/IP supported service families DIB structure contains a set of
supported services and their corresponding versions. The service family is
the high octet of the service type ID and the service family version is an
integer representing the service family version. It refers to the version
of the corresponding KNXnet/IP document, not to the manufacturer's
implemented version.
\note When using QKnxNetIpServiceFamiliesDibProxy, care must be taken to
ensure that the referenced KNXnet/IP DIB structure outlives the proxy on
all code paths, lest the proxy ends up referencing deleted data.
Reading the supported service families can be achieved like this:
\code
auto dib = QKnxNetIpDib::fromBytes(...);
QKnxNetIpServiceFamiliesDibProxy proxy(dib);
if (!proxy.isValid())
return;
auto infos = proxy.serviceInfos();
\endcode
\sa builder(), {Qt KNXnet/IP Connection Classes}
*/
/*!
\internal
\fn QKnxNetIpServiceFamiliesDibProxy::QKnxNetIpServiceFamiliesDibProxy()
*/
/*!
\internal
\fn QKnxNetIpServiceFamiliesDibProxy::~QKnxNetIpServiceFamiliesDibProxy()
*/
/*!
\internal
\fn QKnxNetIpServiceFamiliesDibProxy::QKnxNetIpServiceFamiliesDibProxy(const QKnxNetIpDib &&)
*/
/*!
Constructs a proxy object with the specified KNXnet/IP DIB structure
\a dib to read the supported service families and versions.
*/
QKnxNetIpServiceFamiliesDibProxy::QKnxNetIpServiceFamiliesDibProxy(const QKnxNetIpDib &dib)
: m_dib(dib)
{}
/*!
Returns \c true if the KNXnet/IP structure to create the object is a valid
KNXnet/IP DIB structure; otherwise returns \c false.
*/
bool QKnxNetIpServiceFamiliesDibProxy::isValid() const
{
return m_dib.isValid() && (m_dib.size() % 2 == 0) // must be even sized
&& m_dib.code() == QKnxNetIp::DescriptionType::SupportedServiceFamilies;
}
/*!
Returns the description type of this KNXnet/IP structure if the object
that was passed during construction was valid; otherwise returns
\l QKnx::NetIp::Unknown.
*/
QKnxNetIp::DescriptionType QKnxNetIpServiceFamiliesDibProxy::descriptionType() const
{
if (isValid())
return m_dib.code();
return QKnxNetIp::DescriptionType::Unknown;
}
/*!
Returns a vector of the QKnxServiceInfo carried by this KNXnet/IP DIB
structure if the object that was passed during construction was valid;
otherwise returns an empty vector.
*/
QVector<QKnxServiceInfo> QKnxNetIpServiceFamiliesDibProxy::serviceInfos() const
{
QVector<QKnxServiceInfo> infos;
if (!isValid())
return infos;
const auto &data = m_dib.constData();
for (quint16 i = 0 ; i < m_dib.dataSize() ; i += 2)
infos.append({ QKnxNetIp::ServiceFamily(data.value(i)), data.value(i + 1) });
return infos;
}
/*!
Returns a builder object to create a KNXnet/IP service families DIB
structure.
*/
QKnxNetIpServiceFamiliesDibProxy::Builder QKnxNetIpServiceFamiliesDibProxy::builder()
{
return QKnxNetIpServiceFamiliesDibProxy::Builder();
}
/*!
\class QKnxNetIpServiceFamiliesDibProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpServiceFamiliesDibProxy
\brief The QKnxNetIpServiceFamiliesDibProxy::Builder class creates a
KNXnet/IP supported service families DIB structure.
A KNXnet/IP supported service families DIB structure contains a set of
supported services and their corresponding versions.
The common way to create such a DIB structure is:
\code
auto dib = QKnxNetIpServiceFamiliesDibProxy::builder()
.setServiceInfos({
{ QKnxNetIp::ServiceFamily::Core, 0x01 },
{ QKnxNetIp::ServiceFamily::DeviceManagement, 0x01 },
{ QKnxNetIp::ServiceFamily::IpTunneling, 0x01 }
})
.create();
\endcode
*/
/*!
Sets the supported service families and versions of the KNXnet/IP DIB
structure to \a infos and returns a reference to the builder.
*/
QKnxNetIpServiceFamiliesDibProxy::Builder &
QKnxNetIpServiceFamiliesDibProxy::Builder::setServiceInfos(const QVector<QKnxServiceInfo> &infos)
{
m_infos = infos;
std::sort(m_infos.begin(), m_infos.end(),
[](const QKnxServiceInfo &a, const QKnxServiceInfo &b) {
if (a.ServiceFamily < b.ServiceFamily)
return true;
if (a.ServiceFamily == b.ServiceFamily) {
if (a.ServiceFamilyVersion < b.ServiceFamilyVersion)
return true;
}
return false;
});
m_infos.erase(std::unique(m_infos.begin(), m_infos.end(),
[](const QKnxServiceInfo &a, const QKnxServiceInfo &b) {
return a.ServiceFamily == b.ServiceFamily
&& a.ServiceFamilyVersion == b.ServiceFamilyVersion;
}), m_infos.end());
return *this;
}
/*!
Creates and returns a QKnxNetIpDib.
\note The returned structure may be invalid depending on the values used
during setup.
\sa isValid()
*/
QKnxNetIpDib QKnxNetIpServiceFamiliesDibProxy::Builder::create() const
{
QKnxByteArray bytes;
for (const auto &info : qAsConst(m_infos))
bytes += { quint8(info.ServiceFamily), info.ServiceFamilyVersion };
return { QKnxNetIp::DescriptionType::SupportedServiceFamilies, bytes };
}
QT_END_NAMESPACE
|
