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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qlowenergydescriptordata.h"
#include <QtCore/qbytearray.h>
QT_BEGIN_NAMESPACE
struct QLowEnergyDescriptorDataPrivate : public QSharedData
{
QLowEnergyDescriptorDataPrivate() : readable(true), writable(true) {}
QBluetoothUuid uuid;
QByteArray value;
QBluetooth::AttAccessConstraints readConstraints;
QBluetooth::AttAccessConstraints writeConstraints;
bool readable;
bool writable;
};
/*!
\since 5.7
\class QLowEnergyDescriptorData
\brief The QLowEnergyDescriptorData class is used to create GATT service data.
\inmodule QtBluetooth
\ingroup shared
An object of this class provides a descriptor to be added to a
\l QLowEnergyCharacteristicData object via \l QLowEnergyCharacteristicData::addDescriptor().
\note The member functions related to access permissions are only applicable to those
types of descriptors for which the Bluetooth specification does not prescribe if
and how their values can be accessed.
\sa QLowEnergyCharacteristicData
\sa QLowEnergyServiceData
\sa QLowEnergyController::addService
*/
/*! Creates a new invalid object of this class. */
QLowEnergyDescriptorData::QLowEnergyDescriptorData() : d(new QLowEnergyDescriptorDataPrivate)
{
}
/*!
Creates a new object of this class with UUID and value being provided by \a uuid and \a value,
respectively.
*/
QLowEnergyDescriptorData::QLowEnergyDescriptorData(const QBluetoothUuid &uuid,
const QByteArray &value)
: d(new QLowEnergyDescriptorDataPrivate)
{
setUuid(uuid);
setValue(value);
}
/*! Constructs a new object of this class that is a copy of \a other. */
QLowEnergyDescriptorData::QLowEnergyDescriptorData(const QLowEnergyDescriptorData &other)
: d(other.d)
{
}
/*! Destroys this object. */
QLowEnergyDescriptorData::~QLowEnergyDescriptorData()
{
}
/*! Makes this object a copy of \a other and returns the new value of this object. */
QLowEnergyDescriptorData &QLowEnergyDescriptorData::operator=(const QLowEnergyDescriptorData &other)
{
d = other.d;
return *this;
}
/*! Returns the value of this descriptor. */
QByteArray QLowEnergyDescriptorData::value() const
{
return d->value;
}
/*!
Sets the value of this descriptor to \a value. It will be sent to a peer device
exactly the way it is provided here, so callers need to take care of things such as endianness.
*/
void QLowEnergyDescriptorData::setValue(const QByteArray &value)
{
d->value = value;
}
/*! Returns the UUID of this descriptor. */
QBluetoothUuid QLowEnergyDescriptorData::uuid() const
{
return d->uuid;
}
/*! Sets the UUID of this descriptor to \a uuid. */
void QLowEnergyDescriptorData::setUuid(const QBluetoothUuid &uuid)
{
d->uuid = uuid;
}
/*! Returns true if and only if this object has a non-null UUID. */
bool QLowEnergyDescriptorData::isValid() const
{
return !uuid().isNull();
}
/*!
Specifies whether the value of this descriptor is \a readable and if so, under which
\a constraints.
\sa setWritePermissions()
*/
void QLowEnergyDescriptorData::setReadPermissions(bool readable,
QBluetooth::AttAccessConstraints constraints)
{
d->readable = readable;
d->readConstraints = constraints;
}
/*! Returns \c true if the value of this descriptor is readable and \c false otherwise. */
bool QLowEnergyDescriptorData::isReadable() const
{
return d->readable;
}
/*!
Returns the constraints under which the value of this descriptor can be read. This value
is only relevant if \l isReadable() returns \c true.
*/
QBluetooth::AttAccessConstraints QLowEnergyDescriptorData::readConstraints() const
{
return d->readConstraints;
}
/*!
Specifies whether the value of this descriptor is \a writable and if so, under which
\a constraints.
\sa setReadPermissions()
*/
void QLowEnergyDescriptorData::setWritePermissions(bool writable,
QBluetooth::AttAccessConstraints constraints)
{
d->writable = writable;
d->writeConstraints = constraints;
}
/*! Returns \c true if the value of this descriptor is writable and \c false otherwise. */
bool QLowEnergyDescriptorData::isWritable() const
{
return d->writable;
}
/*!
Returns the constraints under which the value of this descriptor can be written. This value
is only relevant if \l isWritable() returns \c true.
*/
QBluetooth::AttAccessConstraints QLowEnergyDescriptorData::writeConstraints() const
{
return d->writeConstraints;
}
/*!
\fn void QLowEnergyDescriptorData::swap(QLowEnergyDescriptorData &other)
Swaps this object with \a other.
*/
/*!
\fn bool QLowEnergyDescriptorData::operator==(const QLowEnergyDescriptorData &a,
const QLowEnergyDescriptorData &b)
\brief Returns \c true if \a a and \a b are equal with respect to their public state,
otherwise returns \c false.
*/
/*!
\fn bool QLowEnergyDescriptorData::operator!=(const QLowEnergyDescriptorData &a,
const QLowEnergyDescriptorData &b)
\brief Returns \c true if \a a and \a b are unequal with respect to their public state,
otherwise returns \c false.
*/
/*!
\brief Returns \c true if \a a and \a b are equal with respect to their public state,
otherwise returns \c false.
\internal
*/
bool QLowEnergyDescriptorData::equals(const QLowEnergyDescriptorData &a,
const QLowEnergyDescriptorData &b)
{
return a.d == b.d || (
a.uuid() == b.uuid()
&& a.value() == b.value()
&& a.isReadable() == b.isReadable()
&& a.isWritable() == b.isWritable()
&& a.readConstraints() == b.readConstraints()
&& a.writeConstraints() == b.writeConstraints());
}
QT_END_NAMESPACE
|
