summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/qlowenergydescriptordata.cpp
blob: 40bb571cb8b0a9bbf0fc41b56fd9e3b919c19d50 (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtBluetooth module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qlowenergydescriptordata.h"

#include <QtCore/qbytearray.h>

QT_BEGIN_NAMESPACE

struct QLowEnergyDescriptorDataPrivate : public QSharedData
{
    QBluetoothUuid uuid;
    QByteArray value;
};

/*!
    \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().

    \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. 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();
}

/*!
   \fn void QLowEnergyDescriptorData::swap(QLowEnergyDescriptorData &other)
    Swaps this object with \a other.
 */

/*!
   Returns \c true if \a d1 and \a d2 are equal with respect to their public state,
   otherwise returns \c false.
 */
bool operator==(const QLowEnergyDescriptorData &d1, const QLowEnergyDescriptorData &d2)
{
    return d1.d == d2.d || (d1.uuid() == d2.uuid() && d1.value() == d2.value());
}

/*!
   \fn bool operator!=(const QLowEnergyDescriptorData &d1, const QLowEnergyDescriptorData &d2)
   Returns \c true if \a d1 and \a d2 are not equal with respect to their public state,
   otherwise returns \c false.
 */

QT_END_NAMESPACE