ardupilot/libraries/doc/html/_a_p___common_8h.html

142 lines
8.8 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: /home/jgoppert/Projects/ap/libraries/AP_Common/AP_Common.h File 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle">
<h1>/home/jgoppert/Projects/ap/libraries/AP_Common/AP_Common.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Common definitions and utility routines for the ArduPilot libraries.
<a href="#_details">More...</a></p>
<code>#include &lt;stdint.h&gt;</code><br/>
<code>#include &quot;<a class="el" href="menu_8h_source.html">include/menu.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="c_09_09_8h_source.html">c++.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="_a_p___vector_8h_source.html">AP_Vector.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>&quot;</code><br/>
<div class="dynheader">
Include dependency graph for AP_Common.h:</div>
<div class="dyncontent">
<div class="center"><img src="_a_p___common_8h__incl.png" border="0" usemap="#_2home_2jgoppert_2_projects_2ap_2libraries_2_a_p___common_2_a_p___common_8h" alt=""/></div>
<map name="_2home_2jgoppert_2_projects_2ap_2libraries_2_a_p___common_2_a_p___common_8h" id="_2home_2jgoppert_2_projects_2ap_2libraries_2_a_p___common_2_a_p___common_8h">
<area shape="rect" id="node5" href="menu_8h.html" title="Simple commandline menu subsystem. &#160;The Menu class implements a simple CLI that accepts commands type..." alt="" coords="99,83,219,112"/><area shape="rect" id="node7" href="c_09_09_8h.html" title="c++.h" alt="" coords="243,83,304,112"/><area shape="rect" id="node9" href="_a_p___vector_8h.html" title="AP_Vector.h" alt="" coords="332,160,431,189"/><area shape="rect" id="node17" href="_a_p___loop_8h.html" title="AP_Loop.h" alt="" coords="379,83,467,112"/><area shape="rect" id="node15" href="_w_program_8h.html" title="WProgram.h" alt="" coords="448,237,547,267"/></map>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="_a_p___common_8h__dep__incl.png" border="0" usemap="#_2home_2jgoppert_2_projects_2ap_2libraries_2_a_p___common_2_a_p___common_8hdep" alt=""/></div>
<map name="_2home_2jgoppert_2_projects_2ap_2libraries_2_a_p___common_2_a_p___common_8hdep" id="_2home_2jgoppert_2_projects_2ap_2libraries_2_a_p___common_2_a_p___common_8hdep">
<area shape="rect" id="node3" href="_a_p___common_8cpp.html" title="Common utility routines for the ArduPilot libraries." alt="" coords="5,83,456,112"/><area shape="rect" id="node5" href="menu_8cpp.html" title="/home/jgoppert/Projects/ap/libraries/AP_Common/menu.cpp" alt="" coords="480,83,883,112"/><area shape="rect" id="node7" href="_a_p___e_e_prom_8h.html" title="/home/jgoppert/Projects/ap/libraries/AP_EEProm/AP_EEProm.h" alt="" coords="907,83,1323,112"/><area shape="rect" id="node11" href="_a_p___rc_channel_8cpp.html" title="/home/jgoppert/Projects/ap/libraries/AP_RcChannel/AP_RcChannel.cpp" alt="" coords="1347,83,1813,112"/><area shape="rect" id="node9" href="_a_p___e_e_prom_8cpp.html" title="/home/jgoppert/Projects/ap/libraries/AP_EEProm/AP_EEProm.cpp" alt="" coords="899,160,1331,189"/></map>
</div>
<p><a href="_a_p___common_8h_source.html">Go to the source code of this file.</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_location.html">Location</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___var.html">AP_Var&lt; type &gt;</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Warning control</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpbb75df1695a438d2c1d8b28dd6c38c9f"></a>simple menu subsystem </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p___common_8h.html#a75acaba9e781937468d0911423bc0c35">PROGMEM</a>&nbsp;&nbsp;&nbsp;__attribute__(( section(&quot;.progmem.data&quot;) ))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p___common_8h.html#a05ca900ebf7cd121be73c654d9ccb3eb">PSTR</a>(s)&nbsp;&nbsp;&nbsp;(__extension__({static prog_char __c[] PROGMEM = (s); &amp;__c[0];}))</td></tr>
<tr><td colspan="2"><div class="groupHeader">Conversions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp6332798b12e537b25b1c6ad254e14f54"></a> Conversion macros and factors. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_a_p___common_8h.html#a3c9d151923236c7e8ccccf86f131e550">ToDeg</a>(x)&nbsp;&nbsp;&nbsp;(x*57.2957795131)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Common definitions and utility routines for the ArduPilot libraries. </p>
<p>Definition in file <a class="el" href="_a_p___common_8h_source.html">AP_Common.h</a>.</p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a75acaba9e781937468d0911423bc0c35"></a><!-- doxytag: member="AP_Common.h::PROGMEM" ref="a75acaba9e781937468d0911423bc0c35" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PROGMEM&nbsp;&nbsp;&nbsp;__attribute__(( section(&quot;.progmem.data&quot;) ))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___common_8h_source.html#l00064">64</a> of file <a class="el" href="_a_p___common_8h_source.html">AP_Common.h</a>.</p>
</div>
</div>
<a class="anchor" id="a05ca900ebf7cd121be73c654d9ccb3eb"></a><!-- doxytag: member="AP_Common.h::PSTR" ref="a05ca900ebf7cd121be73c654d9ccb3eb" args="(s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PSTR</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">s</td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;(__extension__({static prog_char __c[] PROGMEM = (s); &amp;__c[0];}))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___common_8h_source.html#l00066">66</a> of file <a class="el" href="_a_p___common_8h_source.html">AP_Common.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3c9d151923236c7e8ccccf86f131e550"></a><!-- doxytag: member="AP_Common.h::ToDeg" ref="a3c9d151923236c7e8ccccf86f131e550" args="(x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ToDeg</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname">x</td>
<td>&nbsp;)&nbsp;</td>
<td>&nbsp;&nbsp;&nbsp;(x*57.2957795131)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>XXX this should probably be replaced with radians()/degrees(), but their inclusion in wiring.h makes doing that here difficult. </p>
<p>Definition at line <a class="el" href="_a_p___common_8h_source.html#l00177">177</a> of file <a class="el" href="_a_p___common_8h_source.html">AP_Common.h</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Dec 26 2010 19:58:34 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>