summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/qlowenergydescriptorinfo.cpp
blob: 430220fc2b3b91d26dc792c9ba5431b4cf9d728e (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/***************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Copyright (C) 2013 BlackBerry Limited. All rights reserved.
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtBluetooth module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 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 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qlowenergydescriptorinfo.h"
#include "qlowenergydescriptorinfo_p.h"

QT_BEGIN_NAMESPACE

/*!
    \class QLowEnergyDescriptorInfo
    \inmodule QtBluetooth
    \brief The QLowEnergyDescriptorInfo class stores information about the Bluetooth
    Low Energy descriptor.
    \since 5.4

    QLowEnergyDescriptorInfo provides information about a Bluetooth Low Energy
    descriptor's name, UUID, value and handle. Descriptors are contained in the
    Bluetooth Low Energy characteristic and they provide additional information
    about the characteristic (data format, notification activation, etc).
*/

QLowEnergyDescriptorInfoPrivate::QLowEnergyDescriptorInfoPrivate(const QBluetoothUuid &uuid, const QString &handle)
    :   m_uuid(uuid), m_handle(handle),
        m_type(QBluetoothUuid::ClientCharacteristicConfiguration) //by default a notification
{
#ifdef QT_QNX_BLUETOOTH
    instance = -1;
#endif
}

QLowEnergyDescriptorInfoPrivate::~QLowEnergyDescriptorInfoPrivate()
{

}

/*!
    Construct a new QLowEnergyCharacteristicInfo with given \a uuid.
*/
QLowEnergyDescriptorInfo::QLowEnergyDescriptorInfo(const QBluetoothUuid &uuid):
    d_ptr(new QLowEnergyDescriptorInfoPrivate(uuid, QStringLiteral("0x0000")))
{
}

/*!
    \internal
    Construct a new QLowEnergyDescriptorInfo with given parent
    characteristic \a uuid, descriptor \a type and \a handle.
*/
QLowEnergyDescriptorInfo::QLowEnergyDescriptorInfo(const QBluetoothUuid &uuid,
                                                   QBluetoothUuid::DescriptorType type,
                                                   const QString &handle):
    d_ptr(new QLowEnergyDescriptorInfoPrivate(uuid, handle))
{
    d_ptr->m_type = type;
}

/*!
    Destroys the QLowEnergyDescriptorInfo object.
*/
QLowEnergyDescriptorInfo::~QLowEnergyDescriptorInfo()
{

}

/*!
    Makes a copy of the \a other and assigns it to this QLowEnergyDescriptorInfo object.
    The two copies continue to share the same service and registration details.
*/
QLowEnergyDescriptorInfo &QLowEnergyDescriptorInfo::operator=(const QLowEnergyDescriptorInfo &other)
{
    d_ptr = other.d_ptr;
    return *this;
}

/*!
    Returns the UUID of the characteristic that this descriptor belongs to.
*/

//TODO should this return the characteristic uuid or indeed 0x2902?
QBluetoothUuid QLowEnergyDescriptorInfo::uuid() const
{
    return d_ptr->m_uuid;
}

/*!
    Returns the handle of the descriptor.
*/
QString QLowEnergyDescriptorInfo::handle() const
{
    return d_ptr->m_handle;
}

/*!
    Returns the value of the descriptor.
*/
QByteArray QLowEnergyDescriptorInfo::value() const
{
    return d_ptr->m_value;
}

/*!
    Returns the name of the descriptor type.

    \sa type()
*/
//TODO check that we really need this function. The static
//     QBluetoothUuid::descriptorToString should actually be sufficient.
QString QLowEnergyDescriptorInfo::name() const
{
    return QBluetoothUuid::descriptorToString(
                static_cast<QBluetoothUuid::DescriptorType>(d_ptr->m_type));
}

/*!
    Returns the type of descriptor.
 */
QBluetoothUuid::DescriptorType QLowEnergyDescriptorInfo::type() const
{
    return d_ptr->m_type;
}

/*!
    Sets the value \a value of the descriptor. This only caches the value. To write
    a value directly to the device QLowEnergyController class must be used.

    \sa QLowEnergyController::writeDescriptor()
*/
void QLowEnergyDescriptorInfo::setValue(const QByteArray &value)
{
    d_ptr->m_value = value;
}

QT_END_NAMESPACE