mirror of https://github.com/ArduPilot/ardupilot
125 lines
6.0 KiB
HTML
125 lines
6.0 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: Menu::arg Struct 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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navpath">
|
|
<ul>
|
|
<li><a class="el" href="class_menu.html">Menu</a> </li>
|
|
<li><a class="el" href="struct_menu_1_1arg.html">Menu::arg</a> </li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Public Attributes</a> </div>
|
|
<div class="headertitle">
|
|
<h1>Menu::arg Struct Reference</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<!-- doxytag: class="Menu::arg" -->
|
|
<p><code>#include <<a class="el" href="menu_8h_source.html">menu.h</a>></code></p>
|
|
|
|
<p><a href="struct_menu_1_1arg-members.html">List of all members.</a></p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_menu_1_1arg.html#ad5a8d057d82e7300c34b648c796c8df4">str</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">string form of the argument <a href="#ad5a8d057d82e7300c34b648c796c8df4"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_menu_1_1arg.html#ad6913164599db6376da758a0f1a9ee1c">i</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">integer form of the argument (if a number) <a href="#ad6913164599db6376da758a0f1a9ee1c"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_menu_1_1arg.html#aee33499a1cd6a4edfe5c5b8e6cf42766">f</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">floating point form of the argument (if a number) <a href="#aee33499a1cd6a4edfe5c5b8e6cf42766"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>argument passed to a menu function</p>
|
|
<p>Space-delimited arguments are parsed from the commandline and separated into these structures.</p>
|
|
<p>If the argument cannot be parsed as a float or a long, the value of f or i respectively is undefined. You should range-check the inputs to your function. </p>
|
|
|
|
<p>Definition at line <a class="el" href="menu_8h_source.html#l00035">35</a> of file <a class="el" href="menu_8h_source.html">menu.h</a>.</p>
|
|
<hr/><h2>Member Data Documentation</h2>
|
|
<a class="anchor" id="aee33499a1cd6a4edfe5c5b8e6cf42766"></a><!-- doxytag: member="Menu::arg::f" ref="aee33499a1cd6a4edfe5c5b8e6cf42766" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float <a class="el" href="struct_menu_1_1arg.html#aee33499a1cd6a4edfe5c5b8e6cf42766">Menu::arg::f</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>floating point form of the argument (if a number) </p>
|
|
|
|
<p>Definition at line <a class="el" href="menu_8h_source.html#l00038">38</a> of file <a class="el" href="menu_8h_source.html">menu.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad6913164599db6376da758a0f1a9ee1c"></a><!-- doxytag: member="Menu::arg::i" ref="ad6913164599db6376da758a0f1a9ee1c" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long <a class="el" href="struct_menu_1_1arg.html#ad6913164599db6376da758a0f1a9ee1c">Menu::arg::i</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>integer form of the argument (if a number) </p>
|
|
|
|
<p>Definition at line <a class="el" href="menu_8h_source.html#l00037">37</a> of file <a class="el" href="menu_8h_source.html">menu.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad5a8d057d82e7300c34b648c796c8df4"></a><!-- doxytag: member="Menu::arg::str" ref="ad5a8d057d82e7300c34b648c796c8df4" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char* <a class="el" href="struct_menu_1_1arg.html#ad5a8d057d82e7300c34b648c796c8df4">Menu::arg::str</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>string form of the argument </p>
|
|
|
|
<p>Definition at line <a class="el" href="menu_8h_source.html#l00036">36</a> of file <a class="el" href="menu_8h_source.html">menu.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="menu_8h_source.html">menu.h</a></li>
|
|
</ul>
|
|
</div>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated for ArduPilot Libraries by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a></small></address>
|
|
</body>
|
|
</html>
|