Mirror
/
ardupilot
mirror of https://github.com/ArduPilot/ardupilot
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ardupilot/libraries/doc/html/class_range_finder.html

324 lines
16 KiB
HTML
Raw Blame History

<!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: RangeFinder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- 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="pages.html"><span>Related&nbsp;Pages</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>RangeFinder Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="RangeFinder" -->
<p><code>#include &lt;<a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>&gt;</code></p>
<p>Inherited by <a class="el" href="class_a_p___range_finder___maxsonar_l_v.html">AP_RangeFinder_MaxsonarLV</a>, <a class="el" href="class_a_p___range_finder___maxsonar_x_l.html">AP_RangeFinder_MaxsonarXL</a>, and <a class="el" href="class_a_p___range_finder___sharp_g_p2_y.html">AP_RangeFinder_SharpGP2Y</a>.</p>
<p><a href="class_range_finder-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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a833cdd23c2de887860e50e0180601add">filter</a> (int latestValue)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a0f92e743905971f1807fc100f0b99218">init</a> (int analogPort)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a7d6aef1559f205bac93327078c58840a">set_orientation</a> (int x, int y, int z)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a4dfe0b901e3551141dd08618219e037f">read</a> ()</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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a93f1fae66bdb0f5b411a3f81e9edf138">_analogPort</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#ab23a1a69f5b96fd791491f845ad1bfdb">_history_ptr</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a4f45693be996b3395f063a4624b853b4">_history</a> [AP_RANGEFINDER_NUM_AVERAGES]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a3302ba2e251a3837b031925e1d7da70a">raw_value</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#aff9e96ba48f000d6b7db0770ee5d7026">distance</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a6831ca88e4ca73e80f46fb252a786b5d">max_distance</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#abb14b4bcb72e92ff74ad4e6e17f5d460">min_distance</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a8cb4faa15ec6ff0e3b36420d56affd22">orientation_x</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a6541be7eef7c55b9c20b0de4bf5f88a5">orientation_y</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_range_finder.html#a559d092b3e3c550b4352d7c0ad3b6e84">orientation_z</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00019">19</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a833cdd23c2de887860e50e0180601add"></a><!-- doxytag: member="RangeFinder::filter" ref="a833cdd23c2de887860e50e0180601add" args="(int latestValue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int RangeFinder::filter </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>latestValue</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8cpp_source.html#l00028">28</a> of file <a class="el" href="_range_finder_8cpp_source.html">RangeFinder.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0f92e743905971f1807fc100f0b99218"></a><!-- doxytag: member="RangeFinder::init" ref="a0f92e743905971f1807fc100f0b99218" args="(int analogPort)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void RangeFinder::init </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>analogPort</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="class_a_p___range_finder___maxsonar_l_v.html#a9c6cbba3efe79ecee0b0dc9303b8eaa9">AP_RangeFinder_MaxsonarLV</a>, <a class="el" href="class_a_p___range_finder___maxsonar_x_l.html#a43968b6315937bf0fbfa500f19371319">AP_RangeFinder_MaxsonarXL</a>, and <a class="el" href="class_a_p___range_finder___sharp_g_p2_y.html#aed177de0b908f48fe2fc4f50ccd875a4">AP_RangeFinder_SharpGP2Y</a>.</p>
</div>
</div>
<a class="anchor" id="a4dfe0b901e3551141dd08618219e037f"></a><!-- doxytag: member="RangeFinder::read" ref="a4dfe0b901e3551141dd08618219e037f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int RangeFinder::read </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="class_a_p___range_finder___maxsonar_l_v.html#a5181a7a148c584b830b4686c18ca7fc1">AP_RangeFinder_MaxsonarLV</a>, <a class="el" href="class_a_p___range_finder___maxsonar_x_l.html#a56326acdd26362ebed43557b40c30dbe">AP_RangeFinder_MaxsonarXL</a>, and <a class="el" href="class_a_p___range_finder___sharp_g_p2_y.html#a25f239e25edd7fbcd98cc24aeaf389e2">AP_RangeFinder_SharpGP2Y</a>.</p>
</div>
</div>
<a class="anchor" id="a7d6aef1559f205bac93327078c58840a"></a><!-- doxytag: member="RangeFinder::set_orientation" ref="a7d6aef1559f205bac93327078c58840a" args="(int x, int y, int z)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RangeFinder::set_orientation </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>z</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8cpp_source.html#l00020">20</a> of file <a class="el" href="_range_finder_8cpp_source.html">RangeFinder.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a93f1fae66bdb0f5b411a3f81e9edf138"></a><!-- doxytag: member="RangeFinder::_analogPort" ref="a93f1fae66bdb0f5b411a3f81e9edf138" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#a93f1fae66bdb0f5b411a3f81e9edf138">RangeFinder::_analogPort</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00022">22</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4f45693be996b3395f063a4624b853b4"></a><!-- doxytag: member="RangeFinder::_history" ref="a4f45693be996b3395f063a4624b853b4" args="[AP_RANGEFINDER_NUM_AVERAGES]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#a4f45693be996b3395f063a4624b853b4">RangeFinder::_history</a>[AP_RANGEFINDER_NUM_AVERAGES]</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00024">24</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab23a1a69f5b96fd791491f845ad1bfdb"></a><!-- doxytag: member="RangeFinder::_history_ptr" ref="ab23a1a69f5b96fd791491f845ad1bfdb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#ab23a1a69f5b96fd791491f845ad1bfdb">RangeFinder::_history_ptr</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00023">23</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="aff9e96ba48f000d6b7db0770ee5d7026"></a><!-- doxytag: member="RangeFinder::distance" ref="aff9e96ba48f000d6b7db0770ee5d7026" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#aff9e96ba48f000d6b7db0770ee5d7026">RangeFinder::distance</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00027">27</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6831ca88e4ca73e80f46fb252a786b5d"></a><!-- doxytag: member="RangeFinder::max_distance" ref="a6831ca88e4ca73e80f46fb252a786b5d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#a6831ca88e4ca73e80f46fb252a786b5d">RangeFinder::max_distance</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00028">28</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="abb14b4bcb72e92ff74ad4e6e17f5d460"></a><!-- doxytag: member="RangeFinder::min_distance" ref="abb14b4bcb72e92ff74ad4e6e17f5d460" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#abb14b4bcb72e92ff74ad4e6e17f5d460">RangeFinder::min_distance</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00029">29</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8cb4faa15ec6ff0e3b36420d56affd22"></a><!-- doxytag: member="RangeFinder::orientation_x" ref="a8cb4faa15ec6ff0e3b36420d56affd22" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#a8cb4faa15ec6ff0e3b36420d56affd22">RangeFinder::orientation_x</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00030">30</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6541be7eef7c55b9c20b0de4bf5f88a5"></a><!-- doxytag: member="RangeFinder::orientation_y" ref="a6541be7eef7c55b9c20b0de4bf5f88a5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#a6541be7eef7c55b9c20b0de4bf5f88a5">RangeFinder::orientation_y</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00030">30</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a559d092b3e3c550b4352d7c0ad3b6e84"></a><!-- doxytag: member="RangeFinder::orientation_z" ref="a559d092b3e3c550b4352d7c0ad3b6e84" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#a559d092b3e3c550b4352d7c0ad3b6e84">RangeFinder::orientation_z</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00030">30</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3302ba2e251a3837b031925e1d7da70a"></a><!-- doxytag: member="RangeFinder::raw_value" ref="a3302ba2e251a3837b031925e1d7da70a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="class_range_finder.html#a3302ba2e251a3837b031925e1d7da70a">RangeFinder::raw_value</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_range_finder_8h_source.html#l00026">26</a> of file <a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_range_finder_8h_source.html">RangeFinder.h</a></li>
<li><a class="el" href="_range_finder_8cpp_source.html">RangeFinder.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>
Generated for ArduPilot Libraries by&nbsp;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a></small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink