<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlowenergycharacteristicdata.cpp -->
<title>QLowEnergyCharacteristicData 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 >QLowEnergyCharacteristicData</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-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">QLowEnergyCharacteristicData Class</h1>
<!-- $$$QLowEnergyCharacteristicData-brief -->
<p>The <a href="qlowenergycharacteristicdata.html">QLowEnergyCharacteristicData</a> class is used to set up GATT service data. <a href="#details">More...</a></p>
<!-- @@@QLowEnergyCharacteristicData -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QLowEnergyCharacteristicData></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="qlowenergycharacteristicdata-members.html">List of all members, including inherited members</a></li>
</ul>
<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="qlowenergycharacteristicdata.html#QLowEnergyCharacteristicData">QLowEnergyCharacteristicData</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#QLowEnergyCharacteristicData-1">QLowEnergyCharacteristicData</a></b>(const QLowEnergyCharacteristicData &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#dtor.QLowEnergyCharacteristicData">~QLowEnergyCharacteristicData</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#addDescriptor">addDescriptor</a></b>(const QLowEnergyDescriptorData &<i>descriptor</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QLowEnergyDescriptorData> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#descriptors">descriptors</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#maximumValueLength">maximumValueLength</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#minimumValueLength">minimumValueLength</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLowEnergyCharacteristic::PropertyTypes </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#properties">properties</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetooth::AttAccessConstraints </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#readConstraints">readConstraints</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#setDescriptors">setDescriptors</a></b>(const QList<QLowEnergyDescriptorData> &<i>descriptors</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#setProperties">setProperties</a></b>(QLowEnergyCharacteristic::PropertyTypes <i>properties</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#setReadConstraints">setReadConstraints</a></b>(QBluetooth::AttAccessConstraints <i>constraints</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.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="qlowenergycharacteristicdata.html#setValue">setValue</a></b>(const QByteArray &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#setValueLength">setValueLength</a></b>(int <i>minimum</i>, int <i>maximum</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#setWriteConstraints">setWriteConstraints</a></b>(QBluetooth::AttAccessConstraints <i>constraints</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#swap">swap</a></b>(QLowEnergyCharacteristicData &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetoothUuid </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#uuid">uuid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#value">value</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBluetooth::AttAccessConstraints </td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#writeConstraints">writeConstraints</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLowEnergyCharacteristicData &</td><td class="memItemRight bottomAlign"><b><a href="qlowenergycharacteristicdata.html#operator-eq">operator=</a></b>(const QLowEnergyCharacteristicData &<i>other</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QLowEnergyCharacteristicData-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qlowenergycharacteristicdata.html">QLowEnergyCharacteristicData</a> class is used to set up GATT service data.</p>
<p>An Object of this class provides a characteristic to be added to a <a href="qlowenergyservicedata.html">QLowEnergyServiceData</a> object via <a href="qlowenergyservicedata.html#addCharacteristic">QLowEnergyServiceData::addCharacteristic</a>().</p>
</div>
<p><b>See also </b><a href="qlowenergyservicedata.html">QLowEnergyServiceData</a> and <a href="qlowenergycontroller.html#addService">QLowEnergyController::addService</a>.</p>
<!-- @@@QLowEnergyCharacteristicData -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLowEnergyCharacteristicData[overload1]$$$QLowEnergyCharacteristicData -->
<h3 class="fn" id="QLowEnergyCharacteristicData"><a name="QLowEnergyCharacteristicData"></a>QLowEnergyCharacteristicData::<span class="name">QLowEnergyCharacteristicData</span>()</h3>
<p>Creates a new invalid object of this class.</p>
<!-- @@@QLowEnergyCharacteristicData -->
<!-- $$$QLowEnergyCharacteristicData$$$QLowEnergyCharacteristicDataconstQLowEnergyCharacteristicData& -->
<h3 class="fn" id="QLowEnergyCharacteristicData-1"><a name="QLowEnergyCharacteristicData-1"></a>QLowEnergyCharacteristicData::<span class="name">QLowEnergyCharacteristicData</span>(const <span class="type"><a href="qlowenergycharacteristicdata.html#QLowEnergyCharacteristicData">QLowEnergyCharacteristicData</a></span> &<i>other</i>)</h3>
<p>Constructs a new object of this class that is a copy of <i>other</i>.</p>
<!-- @@@QLowEnergyCharacteristicData -->
<!-- $$$~QLowEnergyCharacteristicData[overload1]$$$~QLowEnergyCharacteristicData -->
<h3 class="fn" id="dtor.QLowEnergyCharacteristicData"><a name="dtor.QLowEnergyCharacteristicData"></a>QLowEnergyCharacteristicData::<span class="name">~QLowEnergyCharacteristicData</span>()</h3>
<p>Destroys this object.</p>
<!-- @@@~QLowEnergyCharacteristicData -->
<!-- $$$addDescriptor[overload1]$$$addDescriptorconstQLowEnergyDescriptorData& -->
<h3 class="fn" id="addDescriptor"><a name="addDescriptor"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">addDescriptor</span>(const <span class="type"><a href="qlowenergydescriptordata.html">QLowEnergyDescriptorData</a></span> &<i>descriptor</i>)</h3>
<p>Adds <i>descriptor</i> to the list of descriptors of this characteristic, if it is valid.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#setDescriptors">setDescriptors</a>().</p>
<!-- @@@addDescriptor -->
<!-- $$$descriptors[overload1]$$$descriptors -->
<h3 class="fn" id="descriptors"><a name="descriptors"></a><span class="type">QList</span><<span class="type"><a href="qlowenergydescriptordata.html">QLowEnergyDescriptorData</a></span>> QLowEnergyCharacteristicData::<span class="name">descriptors</span>() const</h3>
<p>Returns the descriptors of this characteristic.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#setDescriptors">setDescriptors</a>().</p>
<!-- @@@descriptors -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QLowEnergyCharacteristicData::<span class="name">isValid</span>() const</h3>
<p>Returns true if and only if this characteristic is valid, that is, it has a non-null UUID.</p>
<!-- @@@isValid -->
<!-- $$$maximumValueLength[overload1]$$$maximumValueLength -->
<h3 class="fn" id="maximumValueLength"><a name="maximumValueLength"></a><span class="type">int</span> QLowEnergyCharacteristicData::<span class="name">maximumValueLength</span>() const</h3>
<p>Returns the maximum length in bytes that the value of this characteristic can have. By default, there is no limit beyond the constraints of the data type.</p>
<!-- @@@maximumValueLength -->
<!-- $$$minimumValueLength[overload1]$$$minimumValueLength -->
<h3 class="fn" id="minimumValueLength"><a name="minimumValueLength"></a><span class="type">int</span> QLowEnergyCharacteristicData::<span class="name">minimumValueLength</span>() const</h3>
<p>Returns the minimum length in bytes that the value of this characteristic can have. The default is zero.</p>
<!-- @@@minimumValueLength -->
<!-- $$$properties[overload1]$$$properties -->
<h3 class="fn" id="properties"><a name="properties"></a><span class="type"><a href="qlowenergycharacteristic.html#PropertyType-enum">QLowEnergyCharacteristic::PropertyTypes</a></span> QLowEnergyCharacteristicData::<span class="name">properties</span>() const</h3>
<p>Returns the properties of this characteristic.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#setProperties">setProperties</a>().</p>
<!-- @@@properties -->
<!-- $$$readConstraints[overload1]$$$readConstraints -->
<h3 class="fn" id="readConstraints"><a name="readConstraints"></a><span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> QLowEnergyCharacteristicData::<span class="name">readConstraints</span>() const</h3>
<p>Returns the constraints needed for a client to read the value of this characteristic. If <a href="qlowenergycharacteristicdata.html#properties">properties</a>() does not include <a href="qlowenergycharacteristic.html#PropertyType-enum">QLowEnergyCharacteristic::Read</a>, this value is irrelevant. By default, there are no read constraints.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#setReadConstraints">setReadConstraints</a>().</p>
<!-- @@@readConstraints -->
<!-- $$$setDescriptors[overload1]$$$setDescriptorsconstQList<QLowEnergyDescriptorData>& -->
<h3 class="fn" id="setDescriptors"><a name="setDescriptors"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">setDescriptors</span>(const <span class="type">QList</span><<span class="type"><a href="qlowenergydescriptordata.html">QLowEnergyDescriptorData</a></span>> &<i>descriptors</i>)</h3>
<p>Sets the descriptors of this characteristic to <i>descriptors</i>. Only valid descriptors are considered.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#descriptors">descriptors</a>() and <a href="qlowenergycharacteristicdata.html#addDescriptor">addDescriptor</a>().</p>
<!-- @@@setDescriptors -->
<!-- $$$setProperties[overload1]$$$setPropertiesQLowEnergyCharacteristic::PropertyTypes -->
<h3 class="fn" id="setProperties"><a name="setProperties"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">setProperties</span>(<span class="type"><a href="qlowenergycharacteristic.html#PropertyType-enum">QLowEnergyCharacteristic::PropertyTypes</a></span> <i>properties</i>)</h3>
<p>Sets the properties of this characteristic to <i>properties</i>.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#properties">properties</a>().</p>
<!-- @@@setProperties -->
<!-- $$$setReadConstraints[overload1]$$$setReadConstraintsQBluetooth::AttAccessConstraints -->
<h3 class="fn" id="setReadConstraints"><a name="setReadConstraints"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">setReadConstraints</span>(<span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> <i>constraints</i>)</h3>
<p>Specifies that clients need to fulfill <i>constraints</i> to read the value of this characteristic.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#readConstraints">readConstraints</a>().</p>
<!-- @@@setReadConstraints -->
<!-- $$$setUuid[overload1]$$$setUuidconstQBluetoothUuid& -->
<h3 class="fn" id="setUuid"><a name="setUuid"></a><span class="type">void</span> QLowEnergyCharacteristicData::<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 characteristic to <i>uuid</i>.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#uuid">uuid</a>().</p>
<!-- @@@setUuid -->
<!-- $$$setValue[overload1]$$$setValueconstQByteArray& -->
<h3 class="fn" id="setValue"><a name="setValue"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">setValue</span>(const <span class="type">QByteArray</span> &<i>value</i>)</h3>
<p>Sets the value of this characteristic to <i>value</i>.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#value">value</a>().</p>
<!-- @@@setValue -->
<!-- $$$setValueLength[overload1]$$$setValueLengthintint -->
<h3 class="fn" id="setValueLength"><a name="setValueLength"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">setValueLength</span>(<span class="type">int</span> <i>minimum</i>, <span class="type">int</span> <i>maximum</i>)</h3>
<p>Specifies <i>minimum</i> and <i>maximum</i> to be the smallest and largest length, respectively, that the value of this characteristic can have. The unit is bytes. If <i>minimum</i> and <i>maximum</i> are equal, the characteristic has a fixed-length value.</p>
<!-- @@@setValueLength -->
<!-- $$$setWriteConstraints[overload1]$$$setWriteConstraintsQBluetooth::AttAccessConstraints -->
<h3 class="fn" id="setWriteConstraints"><a name="setWriteConstraints"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">setWriteConstraints</span>(<span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> <i>constraints</i>)</h3>
<p>Specifies that clients need to fulfill <i>constraints</i> to write the value of this characteristic.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#writeConstraints">writeConstraints</a>().</p>
<!-- @@@setWriteConstraints -->
<!-- $$$swap[overload1]$$$swapQLowEnergyCharacteristicData& -->
<h3 class="fn" id="swap"><a name="swap"></a><span class="type">void</span> QLowEnergyCharacteristicData::<span class="name">swap</span>(<span class="type"><a href="qlowenergycharacteristicdata.html#QLowEnergyCharacteristicData">QLowEnergyCharacteristicData</a></span> &<i>other</i>)</h3>
<p>Swaps this object with <i>other</i>.</p>
<!-- @@@swap -->
<!-- $$$uuid[overload1]$$$uuid -->
<h3 class="fn" id="uuid"><a name="uuid"></a><span class="type"><a href="qbluetoothuuid.html">QBluetoothUuid</a></span> QLowEnergyCharacteristicData::<span class="name">uuid</span>() const</h3>
<p>Returns the UUID of this characteristic.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#setUuid">setUuid</a>().</p>
<!-- @@@uuid -->
<!-- $$$value[overload1]$$$value -->
<h3 class="fn" id="value"><a name="value"></a><span class="type">QByteArray</span> QLowEnergyCharacteristicData::<span class="name">value</span>() const</h3>
<p>Returns the value of this characteristic.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#setValue">setValue</a>().</p>
<!-- @@@value -->
<!-- $$$writeConstraints[overload1]$$$writeConstraints -->
<h3 class="fn" id="writeConstraints"><a name="writeConstraints"></a><span class="type"><a href="qbluetooth.html#AttAccessConstraint-enum">QBluetooth::AttAccessConstraints</a></span> QLowEnergyCharacteristicData::<span class="name">writeConstraints</span>() const</h3>
<p>Returns the constraints needed for a client to write the value of this characteristic. If <a href="qlowenergycharacteristicdata.html#properties">properties</a>() does not include either of <a href="qlowenergycharacteristic.html#PropertyType-enum">QLowEnergyCharacteristic::Write</a>, <a href="qlowenergycharacteristic.html#PropertyType-enum">QLowEnergyCharacteristic::WriteNoResponse</a> and <a href="qlowenergycharacteristic.html#PropertyType-enum">QLowEnergyCharacteristic::WriteSigned</a>, this value is irrelevant. By default, there are no write constraints.</p>
<p><b>See also </b><a href="qlowenergycharacteristicdata.html#setWriteConstraints">setWriteConstraints</a>().</p>
<!-- @@@writeConstraints -->
<!-- $$$operator=[overload1]$$$operator=constQLowEnergyCharacteristicData& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qlowenergycharacteristicdata.html#QLowEnergyCharacteristicData">QLowEnergyCharacteristicData</a></span> &QLowEnergyCharacteristicData::<span class="name">operator=</span>(const <span class="type"><a href="qlowenergycharacteristicdata.html#QLowEnergyCharacteristicData">QLowEnergyCharacteristicData</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>
