esp32_BNO08x/docs/structbno08x__sample__count...

255 lines
13 KiB
HTML
Raw Normal View 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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp32_BNO08x: bno08x_sample_counts_t Struct 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 id="projectrow">
<td id="projectalign">
<div id="projectname">esp32_BNO08x<span id="projectnumber">&#160;1.4</span>
</div>
<div id="projectbrief">C++ BNO08x IMU driver component for esp-idf.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structbno08x__sample__counts__t.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="#pub-attribs">Public Attributes</a> &#124;
<a href="structbno08x__sample__counts__t-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">bno08x_sample_counts_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Struct to represent sample counts, returned from <a class="el" href="class_b_n_o08x_rpt.html#a7ce8e48cadf59f49068af7f1cb680b38" title="Gets sample counts for this sensor (see SH-2 ref manual 6.4.3.1)">BNO08xRpt::get_sample_counts()</a>
<a href="structbno08x__sample__counts__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_b_n_o08x_global_types_8hpp_source.html">BNO08xGlobalTypes.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abd1eccfac205719fd1c5aed25fee1fec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__sample__counts__t.html#abd1eccfac205719fd1c5aed25fee1fec">bno08x_sample_counts_t</a> ()</td></tr>
<tr class="separator:abd1eccfac205719fd1c5aed25fee1fec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9e52b9fe15c78bd8b2ef3cc5af66a13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbno08x__sample__counts__t.html">bno08x_sample_counts_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__sample__counts__t.html#af9e52b9fe15c78bd8b2ef3cc5af66a13">operator=</a> (const sh2_Counts_t &amp;source)</td></tr>
<tr class="separator:af9e52b9fe15c78bd8b2ef3cc5af66a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aae4244c540f8411246032f1e69125b75"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__sample__counts__t.html#aae4244c540f8411246032f1e69125b75">offered</a></td></tr>
<tr class="memdesc:aae4244c540f8411246032f1e69125b75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of samples produced by underlying data source. <a href="structbno08x__sample__counts__t.html#aae4244c540f8411246032f1e69125b75">More...</a><br /></td></tr>
<tr class="separator:aae4244c540f8411246032f1e69125b75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a055f3d8ff138c7da4a79d4a6fb2af9b9"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__sample__counts__t.html#a055f3d8ff138c7da4a79d4a6fb2af9b9">on</a></td></tr>
<tr class="memdesc:a055f3d8ff138c7da4a79d4a6fb2af9b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of "offered" samples while this sensor was requested by host. <a href="structbno08x__sample__counts__t.html#a055f3d8ff138c7da4a79d4a6fb2af9b9">More...</a><br /></td></tr>
<tr class="separator:a055f3d8ff138c7da4a79d4a6fb2af9b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ab3e0999a5e668833eb8dbab6d1f036"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__sample__counts__t.html#a2ab3e0999a5e668833eb8dbab6d1f036">accepted</a></td></tr>
<tr class="memdesc:a2ab3e0999a5e668833eb8dbab6d1f036"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of "on" samples that passed decimation filter. <a href="structbno08x__sample__counts__t.html#a2ab3e0999a5e668833eb8dbab6d1f036">More...</a><br /></td></tr>
<tr class="separator:a2ab3e0999a5e668833eb8dbab6d1f036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d03182919cce138cfda97c3ff5700b2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__sample__counts__t.html#a8d03182919cce138cfda97c3ff5700b2">attempted</a></td></tr>
<tr class="memdesc:a8d03182919cce138cfda97c3ff5700b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of "accepted" samples that passed threshold requirements and had transmission to the host attempted. <a href="structbno08x__sample__counts__t.html#a8d03182919cce138cfda97c3ff5700b2">More...</a><br /></td></tr>
<tr class="separator:a8d03182919cce138cfda97c3ff5700b2"><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 >Struct to represent sample counts, returned from <a class="el" href="class_b_n_o08x_rpt.html#a7ce8e48cadf59f49068af7f1cb680b38" title="Gets sample counts for this sensor (see SH-2 ref manual 6.4.3.1)">BNO08xRpt::get_sample_counts()</a> </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abd1eccfac205719fd1c5aed25fee1fec" name="abd1eccfac205719fd1c5aed25fee1fec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd1eccfac205719fd1c5aed25fee1fec">&#9670;&nbsp;</a></span>bno08x_sample_counts_t()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bno08x_sample_counts_t::bno08x_sample_counts_t </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af9e52b9fe15c78bd8b2ef3cc5af66a13" name="af9e52b9fe15c78bd8b2ef3cc5af66a13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9e52b9fe15c78bd8b2ef3cc5af66a13">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbno08x__sample__counts__t.html">bno08x_sample_counts_t</a> &amp; bno08x_sample_counts_t::operator= </td>
<td>(</td>
<td class="paramtype">const sh2_Counts_t &amp;&#160;</td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a2ab3e0999a5e668833eb8dbab6d1f036" name="a2ab3e0999a5e668833eb8dbab6d1f036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ab3e0999a5e668833eb8dbab6d1f036">&#9670;&nbsp;</a></span>accepted</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bno08x_sample_counts_t::accepted</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of "on" samples that passed decimation filter. </p>
</div>
</div>
<a id="a8d03182919cce138cfda97c3ff5700b2" name="a8d03182919cce138cfda97c3ff5700b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d03182919cce138cfda97c3ff5700b2">&#9670;&nbsp;</a></span>attempted</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bno08x_sample_counts_t::attempted</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of "accepted" samples that passed threshold requirements and had transmission to the host attempted. </p>
</div>
</div>
<a id="aae4244c540f8411246032f1e69125b75" name="aae4244c540f8411246032f1e69125b75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae4244c540f8411246032f1e69125b75">&#9670;&nbsp;</a></span>offered</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bno08x_sample_counts_t::offered</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of samples produced by underlying data source. </p>
</div>
</div>
<a id="a055f3d8ff138c7da4a79d4a6fb2af9b9" name="a055f3d8ff138c7da4a79d4a6fb2af9b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a055f3d8ff138c7da4a79d4a6fb2af9b9">&#9670;&nbsp;</a></span>on</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bno08x_sample_counts_t::on</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of "offered" samples while this sensor was requested by host. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/media/develop/git/imu_pr_cleanup/components/esp32_BNO08x/include/<a class="el" href="_b_n_o08x_global_types_8hpp_source.html">BNO08xGlobalTypes.hpp</a></li>
</ul>
</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="structbno08x__sample__counts__t.html">bno08x_sample_counts_t</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.4 </li>
</ul>
</div>
</body>
</html>