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_waypoints.html

304 lines
14 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: Waypoints 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="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Waypoints Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Waypoints" -->
<p><code>#include &lt;<a class="el" href="_waypoints_8h_source.html">Waypoints.h</a>&gt;</code></p>
<p><a href="class_waypoints-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_waypoints_1_1_w_p.html">WP</a></td></tr>
<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_waypoints.html#acf16e7693e577540cd0be5b263acb047">Waypoints</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_waypoints_1_1_w_p.html">WP</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_waypoints.html#ab942a563846af24d306e3eb19dfb4a2a">get_waypoint_with_index</a> (uint8_t i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_waypoints_1_1_w_p.html">WP</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_waypoints.html#a0a69eac7c5eadd99d7dcd3df7bb12364">get_current_waypoint</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_waypoints.html#a78f8f60817720baed33b8081e0ae5a82">set_waypoint_with_index</a> (<a class="el" href="struct_waypoints_1_1_w_p.html">Waypoints::WP</a> wp, uint8_t i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_waypoints.html#a41b0874bc4bffb40988d3112a24d0cb2">set_start_byte</a> (uint16_t start_byte)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_waypoints.html#a3087951b9c0727ba23d553e6c56333b8">set_wp_size</a> (uint8_t wp_size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_waypoints.html#a5a1212d730716e107c76a80f38f72488">next_index</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_waypoints.html#a14fe22b108921ce62233d215c60528e3">get_index</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_waypoints.html#a12ee61e5fdd8c7e5943d4beaee20eac0">set_index</a> (uint8_t i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_waypoints.html#ad5b1eaf444c24ab141e7c4b34eece456">get_total</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_waypoints.html#a93835eb97d9725bacec945e7deccc7f4">set_total</a> (uint8_t total)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_waypoints_8h_source.html#l00008">8</a> of file <a class="el" href="_waypoints_8h_source.html">Waypoints.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acf16e7693e577540cd0be5b263acb047"></a><!-- doxytag: member="Waypoints::Waypoints" ref="acf16e7693e577540cd0be5b263acb047" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Waypoints::Waypoints </td>
<td>(</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="_waypoints_8cpp_source.html#l00014">14</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0a69eac7c5eadd99d7dcd3df7bb12364"></a><!-- doxytag: member="Waypoints::get_current_waypoint" ref="a0a69eac7c5eadd99d7dcd3df7bb12364" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_waypoints_1_1_w_p.html">Waypoints::WP</a> Waypoints::get_current_waypoint </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="_waypoints_8cpp_source.html#l00074">74</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a14fe22b108921ce62233d215c60528e3"></a><!-- doxytag: member="Waypoints::get_index" ref="a14fe22b108921ce62233d215c60528e3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Waypoints::get_index </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="_waypoints_8cpp_source.html#l00080">80</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad5b1eaf444c24ab141e7c4b34eece456"></a><!-- doxytag: member="Waypoints::get_total" ref="ad5b1eaf444c24ab141e7c4b34eece456" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Waypoints::get_total </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="_waypoints_8cpp_source.html#l00100">100</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab942a563846af24d306e3eb19dfb4a2a"></a><!-- doxytag: member="Waypoints::get_waypoint_with_index" ref="ab942a563846af24d306e3eb19dfb4a2a" args="(uint8_t i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_waypoints_1_1_w_p.html">Waypoints::WP</a> Waypoints::get_waypoint_with_index </td>
<td>(</td>
<td class="paramtype">uint8_t&nbsp;</td>
<td class="paramname"> <em>i</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_waypoints_8cpp_source.html#l00045">45</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5a1212d730716e107c76a80f38f72488"></a><!-- doxytag: member="Waypoints::next_index" ref="a5a1212d730716e107c76a80f38f72488" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Waypoints::next_index </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="_waypoints_8cpp_source.html#l00086">86</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a12ee61e5fdd8c7e5943d4beaee20eac0"></a><!-- doxytag: member="Waypoints::set_index" ref="a12ee61e5fdd8c7e5943d4beaee20eac0" args="(uint8_t i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Waypoints::set_index </td>
<td>(</td>
<td class="paramtype">uint8_t&nbsp;</td>
<td class="paramname"> <em>i</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_waypoints_8cpp_source.html#l00094">94</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a41b0874bc4bffb40988d3112a24d0cb2"></a><!-- doxytag: member="Waypoints::set_start_byte" ref="a41b0874bc4bffb40988d3112a24d0cb2" args="(uint16_t start_byte)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Waypoints::set_start_byte </td>
<td>(</td>
<td class="paramtype">uint16_t&nbsp;</td>
<td class="paramname"> <em>start_byte</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_waypoints_8cpp_source.html#l00111">111</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a93835eb97d9725bacec945e7deccc7f4"></a><!-- doxytag: member="Waypoints::set_total" ref="a93835eb97d9725bacec945e7deccc7f4" args="(uint8_t total)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Waypoints::set_total </td>
<td>(</td>
<td class="paramtype">uint8_t&nbsp;</td>
<td class="paramname"> <em>total</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_waypoints_8cpp_source.html#l00105">105</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a78f8f60817720baed33b8081e0ae5a82"></a><!-- doxytag: member="Waypoints::set_waypoint_with_index" ref="a78f8f60817720baed33b8081e0ae5a82" args="(Waypoints::WP wp, uint8_t i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Waypoints::set_waypoint_with_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_waypoints_1_1_w_p.html">Waypoints::WP</a>&nbsp;</td>
<td class="paramname"> <em>wp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&nbsp;</td>
<td class="paramname"> <em>i</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_waypoints_8cpp_source.html#l00019">19</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3087951b9c0727ba23d553e6c56333b8"></a><!-- doxytag: member="Waypoints::set_wp_size" ref="a3087951b9c0727ba23d553e6c56333b8" args="(uint8_t wp_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Waypoints::set_wp_size </td>
<td>(</td>
<td class="paramtype">uint8_t&nbsp;</td>
<td class="paramname"> <em>wp_size</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_waypoints_8cpp_source.html#l00117">117</a> of file <a class="el" href="_waypoints_8cpp_source.html">Waypoints.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_waypoints_8h_source.html">Waypoints.h</a></li>
<li><a class="el" href="_waypoints_8cpp_source.html">Waypoints.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