<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlowenergyservicedata.cpp -->
<title>QLowEnergyServiceData Class | Qt Bluetooth 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtbluetooth-index.html">Qt Bluetooth</a></td><td ><a href="qtbluetooth-module.html">C++ Classes</a></td><td >QLowEnergyServiceData</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtbluetooth-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QLowEnergyServiceData Class</h1>
<!-- $$$QLowEnergyServiceData-brief -->
<p>The <a href="qlowenergyservicedata.html">QLowEnergyServiceData</a> class is used to set up GATT service data. <a href="#details">More...</a></p>
<!-- @@@QLowEnergyServiceData -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QLowEnergyServiceData></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += bluetooth</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr></table></div><ul>
<li><a href="qlowenergyservicedata-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#ServiceType-enum">ServiceType</a></b> { ServiceTypePrimary, ServiceTypeSecondary }</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#QLowEnergyServiceData">QLowEnergyServiceData</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#QLowEnergyServiceData-1">QLowEnergyServiceData</a></b>(const QLowEnergyServiceData &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#dtor.QLowEnergyServiceData">~QLowEnergyServiceData</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#addCharacteristic">addCharacteristic</a></b>(const QLowEnergyCharacteristicData &<i>characteristic</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#addIncludedService">addIncludedService</a></b>(QLowEnergyService *<i>service</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QLowEnergyCharacteristicData> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#characteristics">characteristics</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QLowEnergyService *> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#includedServices">includedServices</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#setCharacteristics">setCharacteristics</a></b>(const QList<QLowEnergyCharacteristicData> &<i>characteristics</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#setIncludedServices">setIncludedServices</a></b>(const QList<QLowEnergyService *> &<i>services</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#setType">setType</a></b>(QLowEnergyServiceData::ServiceType <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#setUuid">setUuid</a></b>(const QBluetoothUuid &<i>uuid</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#swap">swap</a></b>(QLowEnergyServiceData &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLowEnergyServiceData::ServiceType </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#type">type</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetoothUuid </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#uuid">uuid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLowEnergyServiceData &</td><td class="memItemRight bottomAlign"><b><a href="qlowenergyservicedata.html#operator-eq">operator=</a></b>(const QLowEnergyServiceData &<i>other</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QLowEnergyServiceData-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qlowenergyservicedata.html">QLowEnergyServiceData</a> class is used to set up GATT service data.</p>
<p>An Object of this class provides a service to be added to a GATT server via <a href="qlowenergycontroller.html#addService">QLowEnergyController::addService</a>().</p>
</div>
<!-- @@@QLowEnergyServiceData -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ServiceType$$$ServiceTypePrimary$$$ServiceTypeSecondary -->
<h3 class="fn" id="ServiceType-enum"><a name="ServiceType-enum"></a>enum QLowEnergyServiceData::<span class="name">ServiceType</span></h3>
<p>The type of GATT service.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QLowEnergyServiceData::ServiceTypePrimary</code></td><td class="topAlign tblval"><code>0x2800</code></td><td class="topAlign">The service is a primary service.</td></tr>
<tr><td class="topAlign"><code>QLowEnergyServiceData::ServiceTypeSecondary</code></td><td class="topAlign tblval"><code>0x2801</code></td><td class="topAlign">The service is a secondary service. Secondary services are included by other services to implement some higher-level functionality.</td></tr>
</table></div>
<!-- @@@ServiceType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLowEnergyServiceData[overload1]$$$QLowEnergyServiceData -->
<h3 class="fn" id="QLowEnergyServiceData"><a name="QLowEnergyServiceData"></a>QLowEnergyServiceData::<span class="name">QLowEnergyServiceData</span>()</h3>
<p>Creates a new invalid object of this class.</p>
<!-- @@@QLowEnergyServiceData -->
<!-- $$$QLowEnergyServiceData$$$QLowEnergyServiceDataconstQLowEnergyServiceData& -->
<h3 class="fn" id="QLowEnergyServiceData-1"><a name="QLowEnergyServiceData-1"></a>QLowEnergyServiceData::<span class="name">QLowEnergyServiceData</span>(const <span class="type"><a href="qlowenergyservicedata.html#QLowEnergyServiceData">QLowEnergyServiceData</a></span> &<i>other</i>)</h3>
<p>Constructs a new object of this class that is a copy of <i>other</i>.</p>
<!-- @@@QLowEnergyServiceData -->
<!-- $$$~QLowEnergyServiceData[overload1]$$$~QLowEnergyServiceData -->
<h3 class="fn" id="dtor.QLowEnergyServiceData"><a name="dtor.QLowEnergyServiceData"></a>QLowEnergyServiceData::<span class="name">~QLowEnergyServiceData</span>()</h3>
<p>Destroys this object.</p>
<!-- @@@~QLowEnergyServiceData -->
<!-- $$$addCharacteristic[overload1]$$$addCharacteristicconstQLowEnergyCharacteristicData& -->
<h3 class="fn" id="addCharacteristic"><a name="addCharacteristic"></a><span class="type">void</span> QLowEnergyServiceData::<span class="name">addCharacteristic</span>(const <span class="type"><a href="qlowenergycharacteristicdata.html">QLowEnergyCharacteristicData</a></span> &<i>characteristic</i>)</h3>
<p>Adds <i>characteristic</i> to the list of characteristics, if it is valid.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#setCharacteristics">setCharacteristics</a>().</p>
<!-- @@@addCharacteristic -->
<!-- $$$addIncludedService[overload1]$$$addIncludedServiceQLowEnergyService* -->
<h3 class="fn" id="addIncludedService"><a name="addIncludedService"></a><span class="type">void</span> QLowEnergyServiceData::<span class="name">addIncludedService</span>(<span class="type"><a href="qlowenergyservice.html">QLowEnergyService</a></span> *<i>service</i>)</h3>
<p>Adds <i>service</i> to the list of included services. The <i>service</i> object must have been returned from a call to <a href="qlowenergycontroller.html#addService">QLowEnergyController::addService</a>. This requirement prevents circular includes (which are forbidden by the Bluetooth specification), and also helps to support the use case of including more than one service of the same type.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#setIncludedServices">setIncludedServices</a>().</p>
<!-- @@@addIncludedService -->
<!-- $$$characteristics[overload1]$$$characteristics -->
<h3 class="fn" id="characteristics"><a name="characteristics"></a><span class="type">QList</span><<span class="type"><a href="qlowenergycharacteristicdata.html">QLowEnergyCharacteristicData</a></span>> QLowEnergyServiceData::<span class="name">characteristics</span>() const</h3>
<p>Returns the list of characteristics.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#setCharacteristics">setCharacteristics</a>().</p>
<!-- @@@characteristics -->
<!-- $$$includedServices[overload1]$$$includedServices -->
<h3 class="fn" id="includedServices"><a name="includedServices"></a><span class="type">QList</span><<span class="type"><a href="qlowenergyservice.html">QLowEnergyService</a></span> *> QLowEnergyServiceData::<span class="name">includedServices</span>() const</h3>
<p>Returns the list of included services.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#setIncludedServices">setIncludedServices</a>().</p>
<!-- @@@includedServices -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QLowEnergyServiceData::<span class="name">isValid</span>() const</h3>
<p>Returns <code>true</code> if this service is has a non-null UUID.</p>
<!-- @@@isValid -->
<!-- $$$setCharacteristics[overload1]$$$setCharacteristicsconstQList<QLowEnergyCharacteristicData>& -->
<h3 class="fn" id="setCharacteristics"><a name="setCharacteristics"></a><span class="type">void</span> QLowEnergyServiceData::<span class="name">setCharacteristics</span>(const <span class="type">QList</span><<span class="type"><a href="qlowenergycharacteristicdata.html">QLowEnergyCharacteristicData</a></span>> &<i>characteristics</i>)</h3>
<p>Sets the list of characteristics to <i>characteristics</i>. Only valid characteristics are considered.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#characteristics">characteristics</a>() and <a href="qlowenergyservicedata.html#addCharacteristic">addCharacteristic</a>().</p>
<!-- @@@setCharacteristics -->
<!-- $$$setIncludedServices[overload1]$$$setIncludedServicesconstQList<QLowEnergyService*>& -->
<h3 class="fn" id="setIncludedServices"><a name="setIncludedServices"></a><span class="type">void</span> QLowEnergyServiceData::<span class="name">setIncludedServices</span>(const <span class="type">QList</span><<span class="type"><a href="qlowenergyservice.html">QLowEnergyService</a></span> *> &<i>services</i>)</h3>
<p>Sets the list of included services to <i>services</i>. All objects in this list must have been returned from a call to <a href="qlowenergycontroller.html#addService">QLowEnergyController::addService</a>.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#includedServices">includedServices</a>() and <a href="qlowenergyservicedata.html#addIncludedService">addIncludedService</a>().</p>
<!-- @@@setIncludedServices -->
<!-- $$$setType[overload1]$$$setTypeQLowEnergyServiceData::ServiceType -->
<h3 class="fn" id="setType"><a name="setType"></a><span class="type">void</span> QLowEnergyServiceData::<span class="name">setType</span>(<span class="type"><a href="qlowenergyservicedata.html#ServiceType-enum">QLowEnergyServiceData::ServiceType</a></span> <i>type</i>)</h3>
<p>Sets the type of this service to <i>type</i>.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#type">type</a>().</p>
<!-- @@@setType -->
<!-- $$$setUuid[overload1]$$$setUuidconstQBluetoothUuid& -->
<h3 class="fn" id="setUuid"><a name="setUuid"></a><span class="type">void</span> QLowEnergyServiceData::<span class="name">setUuid</span>(const <span class="type"><a href="qbluetoothuuid.html">QBluetoothUuid</a></span> &<i>uuid</i>)</h3>
<p>Sets the UUID of this service to <i>uuid</i>.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#uuid">uuid</a>().</p>
<!-- @@@setUuid -->
<!-- $$$swap[overload1]$$$swapQLowEnergyServiceData& -->
<h3 class="fn" id="swap"><a name="swap"></a><span class="type">void</span> QLowEnergyServiceData::<span class="name">swap</span>(<span class="type"><a href="qlowenergyservicedata.html#QLowEnergyServiceData">QLowEnergyServiceData</a></span> &<i>other</i>)</h3>
<p>Swaps this object with <i>other</i>.</p>
<!-- @@@swap -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn" id="type"><a name="type"></a><span class="type"><a href="qlowenergyservicedata.html#ServiceType-enum">QLowEnergyServiceData::ServiceType</a></span> QLowEnergyServiceData::<span class="name">type</span>() const</h3>
<p>Returns the type of this service.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#setType">setType</a>().</p>
<!-- @@@type -->
<!-- $$$uuid[overload1]$$$uuid -->
<h3 class="fn" id="uuid"><a name="uuid"></a><span class="type"><a href="qbluetoothuuid.html">QBluetoothUuid</a></span> QLowEnergyServiceData::<span class="name">uuid</span>() const</h3>
<p>Returns the UUID of this service.</p>
<p><b>See also </b><a href="qlowenergyservicedata.html#setUuid">setUuid</a>().</p>
<!-- @@@uuid -->
<!-- $$$operator=[overload1]$$$operator=constQLowEnergyServiceData& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qlowenergyservicedata.html#QLowEnergyServiceData">QLowEnergyServiceData</a></span> &QLowEnergyServiceData::<span class="name">operator=</span>(const <span class="type"><a href="qlowenergyservicedata.html#QLowEnergyServiceData">QLowEnergyServiceData</a></span> &<i>other</i>)</h3>
<p>Makes this object a copy of <i>other</i> and returns the new value of this object.</p>
<!-- @@@operator= -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
