Cansat
/
esp32_BNO08x
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
esp32_BNO08x/documentation/class_b_n_o08x_cb_param_voi...

224 lines
13 KiB
HTML
Raw Normal View History

regenerated documentation Signed-off-by: myles-parfeniuk <myles.parfenyuk@gmail.com>
2025-06-07 07:45:45 +01:00
<!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: BNO08xCbParamVoid 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 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('class_b_n_o08x_cb_param_void.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_b_n_o08x_cb_param_void-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">BNO08xCbParamVoid Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_b_n_o08x_cb_param_void_8hpp_source.html">callback/BNO08xCbParamVoid.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BNO08xCbParamVoid:</div>
<div class="dyncontent">
<div class="center"><img src="class_b_n_o08x_cb_param_void__inherit__graph.png" border="0" usemap="#a_b_n_o08x_cb_param_void_inherit__map" alt="Inheritance graph"/></div>
<map name="a_b_n_o08x_cb_param_void_inherit__map" id="a_b_n_o08x_cb_param_void_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,167,107"/>
<area shape="rect" href="class_b_n_o08x_cb_generic.html" title="Parent class to represent callback functions as generic type such that all flavors can be invoked by ..." alt="" coords="15,5,157,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for BNO08xCbParamVoid:</div>
<div class="dyncontent">
<div class="center"><img src="class_b_n_o08x_cb_param_void__coll__graph.png" border="0" usemap="#a_b_n_o08x_cb_param_void_coll__map" alt="Collaboration graph"/></div>
<map name="a_b_n_o08x_cb_param_void_coll__map" id="a_b_n_o08x_cb_param_void_coll__map">
<area shape="rect" title=" " alt="" coords="5,80,167,107"/>
<area shape="rect" href="class_b_n_o08x_cb_generic.html" title="Parent class to represent callback functions as generic type such that all flavors can be invoked by ..." alt="" coords="15,5,157,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:a989c124bfd9871f80a415b76510d966b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_cb_param_void.html#a989c124bfd9871f80a415b76510d966b">BNO08xCbParamVoid</a> (std::function&lt; void(void)&gt; cb_fxn, uint8_t <a class="el" href="class_b_n_o08x_cb_generic.html#a808841c9f19664cb6ff06f9c217793e1">rpt_ID</a>)</td></tr>
<tr class="separator:a989c124bfd9871f80a415b76510d966b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cfdaad83528e3e418f51041d500b6f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_cb_param_void.html#a5cfdaad83528e3e418f51041d500b6f9">invoke</a> (uint8_t <a class="el" href="class_b_n_o08x_cb_generic.html#a808841c9f19664cb6ff06f9c217793e1">rpt_ID</a>) override</td></tr>
<tr class="memdesc:a5cfdaad83528e3e418f51041d500b6f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes contained callback function. <a href="class_b_n_o08x_cb_param_void.html#a5cfdaad83528e3e418f51041d500b6f9">More...</a><br /></td></tr>
<tr class="separator:a5cfdaad83528e3e418f51041d500b6f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_b_n_o08x_cb_generic"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_b_n_o08x_cb_generic')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_b_n_o08x_cb_generic.html">BNO08xCbGeneric</a></td></tr>
<tr class="memitem:a19f9e8a22d039acf29c98801368ff0bb inherit pub_methods_class_b_n_o08x_cb_generic"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_cb_generic.html#a19f9e8a22d039acf29c98801368ff0bb">invoke</a> (uint8_t <a class="el" href="class_b_n_o08x_cb_generic.html#a808841c9f19664cb6ff06f9c217793e1">rpt_ID</a>)=0</td></tr>
<tr class="separator:a19f9e8a22d039acf29c98801368ff0bb inherit pub_methods_class_b_n_o08x_cb_generic"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4caa8d4932c70bc07e187f489542ab87 inherit pub_methods_class_b_n_o08x_cb_generic"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_cb_generic.html#a4caa8d4932c70bc07e187f489542ab87">~BNO08xCbGeneric</a> ()=default</td></tr>
<tr class="separator:a4caa8d4932c70bc07e187f489542ab87 inherit pub_methods_class_b_n_o08x_cb_generic"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_class_b_n_o08x_cb_generic"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_b_n_o08x_cb_generic')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_b_n_o08x_cb_generic.html">BNO08xCbGeneric</a></td></tr>
<tr class="memitem:a808841c9f19664cb6ff06f9c217793e1 inherit pub_attribs_class_b_n_o08x_cb_generic"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_cb_generic.html#a808841c9f19664cb6ff06f9c217793e1">rpt_ID</a></td></tr>
<tr class="separator:a808841c9f19664cb6ff06f9c217793e1 inherit pub_attribs_class_b_n_o08x_cb_generic"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_class_b_n_o08x_cb_generic"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_b_n_o08x_cb_generic')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_b_n_o08x_cb_generic.html">BNO08xCbGeneric</a></td></tr>
<tr class="memitem:a5b1984f0111c5ca5e07a7f5487cd5234 inherit pro_methods_class_b_n_o08x_cb_generic"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_b_n_o08x_cb_generic.html#a5b1984f0111c5ca5e07a7f5487cd5234">BNO08xCbGeneric</a> (uint8_t <a class="el" href="class_b_n_o08x_cb_generic.html#a808841c9f19664cb6ff06f9c217793e1">rpt_ID</a>)</td></tr>
<tr class="separator:a5b1984f0111c5ca5e07a7f5487cd5234 inherit pro_methods_class_b_n_o08x_cb_generic"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a989c124bfd9871f80a415b76510d966b" name="a989c124bfd9871f80a415b76510d966b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989c124bfd9871f80a415b76510d966b">&#9670;&nbsp;</a></span>BNO08xCbParamVoid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">BNO08xCbParamVoid::BNO08xCbParamVoid </td>
<td>(</td>
<td class="paramtype">std::function&lt; void(void)&gt;&#160;</td>
<td class="paramname"><em>cb_fxn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rpt_ID</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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="a5cfdaad83528e3e418f51041d500b6f9" name="a5cfdaad83528e3e418f51041d500b6f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cfdaad83528e3e418f51041d500b6f9">&#9670;&nbsp;</a></span>invoke()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BNO08xCbParamVoid::invoke </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rpt_ID</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Invokes contained callback function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rpt_ID</td><td>n/a, not used, kept to maintain same prototype as <a class="el" href="class_b_n_o08x_cb_param_rpt_i_d.html#ae263c2af6f9363d1a4fc58824b53cb72" title="Invokes contained callback function.">BNO08xCbParamRptID::invoke()</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void, nothing to return </dd></dl>
<p>Implements <a class="el" href="class_b_n_o08x_cb_generic.html#a19f9e8a22d039acf29c98801368ff0bb">BNO08xCbGeneric</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/media/develop/git/imu_pr_cleanup/components/esp32_BNO08x/include/callback/<a class="el" href="_b_n_o08x_cb_param_void_8hpp_source.html">BNO08xCbParamVoid.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="class_b_n_o08x_cb_param_void.html">BNO08xCbParamVoid</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>