ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-26 04:30:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/class_nim_b_l_e_scan_results.html
h2zero 6ae5666f7a v1.3.2
2022-01-15 15:23:57 -07:00

246 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp: NimBLEScanResults Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp
&#160;<span id="projectnumber">1.3.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_nim_b_l_e_scan_results.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_scan_results-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NimBLEScanResults Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class that contains and operates on the results of a BLE scan.
<a href="class_nim_b_l_e_scan_results.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2bbead75105733d04796b69e10c56cd4"><td class="memItemLeft" align="right" valign="top"><a id="a2bbead75105733d04796b69e10c56cd4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#a2bbead75105733d04796b69e10c56cd4">dump</a> ()</td></tr>
<tr class="memdesc:a2bbead75105733d04796b69e10c56cd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump the scan results to the log. <br /></td></tr>
<tr class="separator:a2bbead75105733d04796b69e10c56cd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4796dd6ce1845c46f66bc1a36ad746a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a">getCount</a> ()</td></tr>
<tr class="memdesc:ae4796dd6ce1845c46f66bc1a36ad746a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the count of devices found in the last scan. <a href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a">More...</a><br /></td></tr>
<tr class="separator:ae4796dd6ce1845c46f66bc1a36ad746a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68aa3ebffb1be785497f228c1d11e500"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">getDevice</a> (uint32_t i)</td></tr>
<tr class="memdesc:a68aa3ebffb1be785497f228c1d11e500"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the specified device at the given index. The index should be between 0 and <a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a" title="Get the count of devices found in the last scan.">getCount()</a>-1. <a href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500">More...</a><br /></td></tr>
<tr class="separator:a68aa3ebffb1be785497f228c1d11e500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad426f221e8c18c0c3f5784786710e8f0"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0">begin</a> ()</td></tr>
<tr class="memdesc:ad426f221e8c18c0c3f5784786710e8f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning of the vector of advertised device pointers. <a href="class_nim_b_l_e_scan_results.html#ad426f221e8c18c0c3f5784786710e8f0">More...</a><br /></td></tr>
<tr class="separator:ad426f221e8c18c0c3f5784786710e8f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44e183a7ce0c9fb587d11910ce5ef200"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200">end</a> ()</td></tr>
<tr class="memdesc:a44e183a7ce0c9fb587d11910ce5ef200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end of the vector of advertised device pointers. <a href="class_nim_b_l_e_scan_results.html#a44e183a7ce0c9fb587d11910ce5ef200">More...</a><br /></td></tr>
<tr class="separator:a44e183a7ce0c9fb587d11910ce5ef200"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2356f6c1b8384ebc061d4b7953a9374"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_scan_results.html#ac2356f6c1b8384ebc061d4b7953a9374">getDevice</a> (const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;address)</td></tr>
<tr class="memdesc:ac2356f6c1b8384ebc061d4b7953a9374"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to the specified device at the given address. If the address is not found a nullptr is returned. <a href="class_nim_b_l_e_scan_results.html#ac2356f6c1b8384ebc061d4b7953a9374">More...</a><br /></td></tr>
<tr class="separator:ac2356f6c1b8384ebc061d4b7953a9374"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that contains and operates on the results of a BLE scan. </p>
<p>When a scan completes, we have a set of found devices. Each device is described by a <a class="el" href="class_nim_b_l_e_advertised_device.html" title="A representation of a BLE advertised device found by a scan.">NimBLEAdvertisedDevice</a> object. The number of items in the set is given by <a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a" title="Get the count of devices found in the last scan.">getCount()</a>. We can retrieve a device by calling <a class="el" href="class_nim_b_l_e_scan_results.html#a68aa3ebffb1be785497f228c1d11e500" title="Return the specified device at the given index. The index should be between 0 and getCount()-1.">getDevice()</a> passing in the index (starting at 0) of the desired device. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad426f221e8c18c0c3f5784786710e8f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad426f221e8c18c0c3f5784786710e8f0">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator NimBLEScanResults::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the beginning of the vector of advertised device pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the beginning of the vector of advertised device pointers. </dd></dl>
</div>
</div>
<a id="a44e183a7ce0c9fb587d11910ce5ef200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44e183a7ce0c9fb587d11910ce5ef200">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * &gt;::iterator NimBLEScanResults::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get iterator to the end of the vector of advertised device pointers. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the end of the vector of advertised device pointers. </dd></dl>
</div>
</div>
<a id="ae4796dd6ce1845c46f66bc1a36ad746a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4796dd6ce1845c46f66bc1a36ad746a">&#9670;&nbsp;</a></span>getCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int NimBLEScanResults::getCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the count of devices found in the last scan. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of devices found in the last scan. </dd></dl>
</div>
</div>
<a id="ac2356f6c1b8384ebc061d4b7953a9374"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2356f6c1b8384ebc061d4b7953a9374">&#9670;&nbsp;</a></span>getDevice() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> * NimBLEScanResults::getDevice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_address.html">NimBLEAddress</a> &amp;&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to the specified device at the given address. If the address is not found a nullptr is returned. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address of the device. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the device at the specified address. </dd></dl>
</div>
</div>
<a id="a68aa3ebffb1be785497f228c1d11e500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68aa3ebffb1be785497f228c1d11e500">&#9670;&nbsp;</a></span>getDevice() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_nim_b_l_e_advertised_device.html">NimBLEAdvertisedDevice</a> NimBLEScanResults::getDevice </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the specified device at the given index. The index should be between 0 and <a class="el" href="class_nim_b_l_e_scan_results.html#ae4796dd6ce1845c46f66bc1a36ad746a" title="Get the count of devices found in the last scan.">getCount()</a>-1. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>The index of the device. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The device at the specified index. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_scan_results.html">NimBLEScanResults</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink