Ardupilot2/libraries/doc/html/class_a_p___i_m_u.html
james.goppert b852085f44 Updated documentation.
git-svn-id: https://arducopter.googlecode.com/svn/trunk@1287 f9c3cf11-9bcb-44bc-f272-b75c42450872
2010-12-27 02:59:34 +00:00

431 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>ArduPilot Libraries: AP_IMU Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<h1>AP_IMU Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="AP_IMU" -->
<p><code>#include &lt;<a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for AP_IMU:</div>
<div class="dyncontent">
<div class="center"><img src="class_a_p___i_m_u__coll__graph.png" border="0" usemap="#_a_p___i_m_u_coll__map" alt="Collaboration graph"/></div>
<map name="_a_p___i_m_u_coll__map" id="_a_p___i_m_u_coll__map">
<area shape="rect" id="node2" href="class_a_p___a_d_c.html" title="AP_ADC" alt="" coords="5,5,80,35"/><area shape="rect" id="node4" href="class_vector3.html" title="Vector3\&lt; float \&gt;" alt="" coords="104,5,232,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_a_p___i_m_u-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a1a1f69e6f3633497d2c54442f91d004b">AP_IMU</a> (<a class="el" href="class_a_p___a_d_c.html">AP_ADC</a> *adc, uint16_t address)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a9a11140ed95ac3c9897bc2febe26eb77">init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#aa3f086a668117214ba9853e6365e3d0a">init_accel</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a4b0359c017c12d4fbfedebff4e87cdf1">init_gyro</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a972d41a2a9fef4c5ba11d411ab4b5905">zero_accel</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#ad10efda15dac602284616a6e56800efb">load_gyro_eeprom</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a8ac2bdf10de028677126ddb8e19d1461">save_gyro_eeprom</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a4616301dc3a4cb739d3b62dd9bdc83d2">load_accel_eeprom</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a9009257aec9cdd8e0f2366b0ad74ecfd">save_accel_eeprom</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#aae1c9f706c123b598ea503edb85e232e">print_accel_offsets</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a2acce1a94d9f8cb636682b2526006007">print_gyro_offsets</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a6b79bbe7ac13e88e1151230f758582f9">ax</a> (const int v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#ad47db745596d30caa3e89b8a5aede888">ay</a> (const int v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a16f63c6b5393e44c1aea01d73438a10e">az</a> (const int v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vector3.html">Vector3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#ae3d7b3a78a8720c9a7ca2c85402c7638">get_gyro</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vector3.html">Vector3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#a6e9be9f56658410ac972d66b8985de6b">get_accel</a> (void)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___i_m_u.html#ad26b4707a58e838f2684d335374c34aa">adc_constraints</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_a_p___i_m_u_8h_source.html#l00012">12</a> of file <a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1a1f69e6f3633497d2c54442f91d004b"></a><!-- doxytag: member="AP_IMU::AP_IMU" ref="a1a1f69e6f3633497d2c54442f91d004b" args="(AP_ADC *adc, uint16_t address)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AP_IMU::AP_IMU </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_a_p___a_d_c.html">AP_ADC</a> *&nbsp;</td>
<td class="paramname"> <em>adc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&nbsp;</td>
<td class="paramname"> <em>address</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8h_source.html#l00017">17</a> of file <a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6b79bbe7ac13e88e1151230f758582f9"></a><!-- doxytag: member="AP_IMU::ax" ref="a6b79bbe7ac13e88e1151230f758582f9" args="(const int v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::ax </td>
<td>(</td>
<td class="paramtype">const int&nbsp;</td>
<td class="paramname"> <em>v</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8h_source.html#l00035">35</a> of file <a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad47db745596d30caa3e89b8a5aede888"></a><!-- doxytag: member="AP_IMU::ay" ref="ad47db745596d30caa3e89b8a5aede888" args="(const int v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::ay </td>
<td>(</td>
<td class="paramtype">const int&nbsp;</td>
<td class="paramname"> <em>v</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8h_source.html#l00036">36</a> of file <a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a>.</p>
</div>
</div>
<a class="anchor" id="a16f63c6b5393e44c1aea01d73438a10e"></a><!-- doxytag: member="AP_IMU::az" ref="a16f63c6b5393e44c1aea01d73438a10e" args="(const int v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::az </td>
<td>(</td>
<td class="paramtype">const int&nbsp;</td>
<td class="paramname"> <em>v</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8h_source.html#l00037">37</a> of file <a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6e9be9f56658410ac972d66b8985de6b"></a><!-- doxytag: member="AP_IMU::get_accel" ref="a6e9be9f56658410ac972d66b8985de6b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_vector3.html">Vector3f</a> AP_IMU::get_accel </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00222">222</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae3d7b3a78a8720c9a7ca2c85402c7638"></a><!-- doxytag: member="AP_IMU::get_gyro" ref="ae3d7b3a78a8720c9a7ca2c85402c7638" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_vector3.html">Vector3f</a> AP_IMU::get_gyro </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00195">195</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9a11140ed95ac3c9897bc2febe26eb77"></a><!-- doxytag: member="AP_IMU::init" ref="a9a11140ed95ac3c9897bc2febe26eb77" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::init </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00058">58</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa3f086a668117214ba9853e6365e3d0a"></a><!-- doxytag: member="AP_IMU::init_accel" ref="aa3f086a668117214ba9853e6365e3d0a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::init_accel </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00124">124</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4b0359c017c12d4fbfedebff4e87cdf1"></a><!-- doxytag: member="AP_IMU::init_gyro" ref="a4b0359c017c12d4fbfedebff4e87cdf1" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::init_gyro </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00067">67</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4616301dc3a4cb739d3b62dd9bdc83d2"></a><!-- doxytag: member="AP_IMU::load_accel_eeprom" ref="a4616301dc3a4cb739d3b62dd9bdc83d2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::load_accel_eeprom </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00267">267</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad10efda15dac602284616a6e56800efb"></a><!-- doxytag: member="AP_IMU::load_gyro_eeprom" ref="ad10efda15dac602284616a6e56800efb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::load_gyro_eeprom </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00249">249</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aae1c9f706c123b598ea503edb85e232e"></a><!-- doxytag: member="AP_IMU::print_accel_offsets" ref="aae1c9f706c123b598ea503edb85e232e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::print_accel_offsets </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00283">283</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2acce1a94d9f8cb636682b2526006007"></a><!-- doxytag: member="AP_IMU::print_gyro_offsets" ref="a2acce1a94d9f8cb636682b2526006007" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::print_gyro_offsets </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00294">294</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9009257aec9cdd8e0f2366b0ad74ecfd"></a><!-- doxytag: member="AP_IMU::save_accel_eeprom" ref="a9009257aec9cdd8e0f2366b0ad74ecfd" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::save_accel_eeprom </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00275">275</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8ac2bdf10de028677126ddb8e19d1461"></a><!-- doxytag: member="AP_IMU::save_gyro_eeprom" ref="a8ac2bdf10de028677126ddb8e19d1461" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::save_gyro_eeprom </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00257">257</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a972d41a2a9fef4c5ba11d411ab4b5905"></a><!-- doxytag: member="AP_IMU::zero_accel" ref="a972d41a2a9fef4c5ba11d411ab4b5905" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_IMU::zero_accel </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8cpp_source.html#l00175">175</a> of file <a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ad26b4707a58e838f2684d335374c34aa"></a><!-- doxytag: member="AP_IMU::adc_constraints" ref="ad26b4707a58e838f2684d335374c34aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="class_a_p___i_m_u.html#ad26b4707a58e838f2684d335374c34aa">AP_IMU::adc_constraints</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___i_m_u_8h_source.html#l00045">45</a> of file <a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/jgoppert/Projects/ap/libraries/AP_IMU/<a class="el" href="_a_p___i_m_u_8h_source.html">AP_IMU.h</a></li>
<li>/home/jgoppert/Projects/ap/libraries/AP_IMU/<a class="el" href="_a_p___i_m_u_8cpp_source.html">AP_IMU.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Dec 26 2010 21:58:35 for ArduPilot Libraries by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>