esp32_BNO08x/documentation/html/structbno08x__raw__magf__t....

259 lines
12 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_raw_magf_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__raw__magf__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__raw__magf__t-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">bno08x_raw_magf_t Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Struct to represent raw mems magnetometer data from raw magnetometer reports (units in ADC counts).
<a href="structbno08x__raw__magf__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:a9bbd61edac01cb1f2e78417efe8573aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__raw__magf__t.html#a9bbd61edac01cb1f2e78417efe8573aa">bno08x_raw_magf_t</a> ()</td></tr>
<tr class="separator:a9bbd61edac01cb1f2e78417efe8573aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad58e25ff5c6d8c4c3843264effa63a7c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbno08x__raw__magf__t.html">bno08x_raw_magf_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__raw__magf__t.html#ad58e25ff5c6d8c4c3843264effa63a7c">operator=</a> (const sh2_RawMagnetometer_t &amp;source)</td></tr>
<tr class="separator:ad58e25ff5c6d8c4c3843264effa63a7c"><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:a74cb298f230665c2d600d3298717c321"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__raw__magf__t.html#a74cb298f230665c2d600d3298717c321">timestamp_us</a></td></tr>
<tr class="separator:a74cb298f230665c2d600d3298717c321"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d04fa2589070ad4ee06b7259fc90900"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__raw__magf__t.html#a6d04fa2589070ad4ee06b7259fc90900">x</a></td></tr>
<tr class="separator:a6d04fa2589070ad4ee06b7259fc90900"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba0a88c1032210c6db95ac779e280b9a"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__raw__magf__t.html#aba0a88c1032210c6db95ac779e280b9a">y</a></td></tr>
<tr class="separator:aba0a88c1032210c6db95ac779e280b9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d50e05cccd1f92f36f6ac83e9f911ae"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__raw__magf__t.html#a5d50e05cccd1f92f36f6ac83e9f911ae">z</a></td></tr>
<tr class="separator:a5d50e05cccd1f92f36f6ac83e9f911ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1253faa56aecbafd24f24f42dfb3aeb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_b_n_o08x_global_types_8hpp.html#a6bdf6fea6d671c12413d95f36a3e7ba6">BNO08xAccuracy</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbno08x__raw__magf__t.html#ae1253faa56aecbafd24f24f42dfb3aeb">accuracy</a></td></tr>
<tr class="separator:ae1253faa56aecbafd24f24f42dfb3aeb"><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 raw mems magnetometer data from raw magnetometer reports (units in ADC counts). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9bbd61edac01cb1f2e78417efe8573aa" name="a9bbd61edac01cb1f2e78417efe8573aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bbd61edac01cb1f2e78417efe8573aa">&#9670;&nbsp;</a></span>bno08x_raw_magf_t()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bno08x_raw_magf_t::bno08x_raw_magf_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="ad58e25ff5c6d8c4c3843264effa63a7c" name="ad58e25ff5c6d8c4c3843264effa63a7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad58e25ff5c6d8c4c3843264effa63a7c">&#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__raw__magf__t.html">bno08x_raw_magf_t</a> &amp; bno08x_raw_magf_t::operator= </td>
<td>(</td>
<td class="paramtype">const sh2_RawMagnetometer_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="ae1253faa56aecbafd24f24f42dfb3aeb" name="ae1253faa56aecbafd24f24f42dfb3aeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1253faa56aecbafd24f24f42dfb3aeb">&#9670;&nbsp;</a></span>accuracy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_b_n_o08x_global_types_8hpp.html#a6bdf6fea6d671c12413d95f36a3e7ba6">BNO08xAccuracy</a> bno08x_raw_magf_t::accuracy</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a74cb298f230665c2d600d3298717c321" name="a74cb298f230665c2d600d3298717c321"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74cb298f230665c2d600d3298717c321">&#9670;&nbsp;</a></span>timestamp_us</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t bno08x_raw_magf_t::timestamp_us</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6d04fa2589070ad4ee06b7259fc90900" name="a6d04fa2589070ad4ee06b7259fc90900"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d04fa2589070ad4ee06b7259fc90900">&#9670;&nbsp;</a></span>x</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t bno08x_raw_magf_t::x</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aba0a88c1032210c6db95ac779e280b9a" name="aba0a88c1032210c6db95ac779e280b9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba0a88c1032210c6db95ac779e280b9a">&#9670;&nbsp;</a></span>y</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t bno08x_raw_magf_t::y</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5d50e05cccd1f92f36f6ac83e9f911ae" name="a5d50e05cccd1f92f36f6ac83e9f911ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d50e05cccd1f92f36f6ac83e9f911ae">&#9670;&nbsp;</a></span>z</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t bno08x_raw_magf_t::z</td>
</tr>
</table>
</div><div class="memdoc">
</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__raw__magf__t.html">bno08x_raw_magf_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>