ardupilot/libraries/doc/html/classapo_1_1_loop.html
2010-12-27 03:23:35 +00:00

270 lines
12 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: apo::Loop 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="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 class="navpath">
<ul>
<li><a class="el" href="namespaceapo.html">apo</a> </li>
<li><a class="el" href="classapo_1_1_loop.html">apo::Loop</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>apo::Loop Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="apo::Loop" -->
<p><code>#include &lt;<a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for apo::Loop:</div>
<div class="dyncontent">
<div class="center"><img src="classapo_1_1_loop__coll__graph.png" border="0" usemap="#apo_1_1_loop_coll__map" alt="Collaboration graph"/></div>
<map name="apo_1_1_loop_coll__map" id="apo_1_1_loop_coll__map">
<area shape="rect" id="node2" href="class_vector.html" title="Vector\&lt; Loop * \&gt;" alt="" coords="5,101,139,131"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classapo_1_1_loop-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="classapo_1_1_loop.html#a4a6ea4aeec32061bf86df9c9c32c5b24">Loop</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#a75dc072e1d02ad2fe0cd56c6f3926ca3">Loop</a> (float frequency, void(*fptr)(void *)=NULL, void *data=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#a9e46986a766ed78a9fff0667d9dcf813">update</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vector.html">Vector</a>&lt; <a class="el" href="classapo_1_1_loop.html">Loop</a> * &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#a35a3d49da20cbad8a4dc863228632a57">subLoops</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#a6b88aae6e3f55895037ce5538f36076d">frequency</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#aec93940b1c7ca50ebda47b7326c339ba">frequency</a> (float frequency)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#af6f23eac39d89deb194d3e3f5cdd8df1">timeStamp</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#a0dd58e809ffa1104cdd9e008918886aa">dt</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classapo_1_1_loop.html#af3017e1bf118c134e550cdda81c54d43">load</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_a_p___loop_8h_source.html#l00032">32</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4a6ea4aeec32061bf86df9c9c32c5b24"></a><!-- doxytag: member="apo::Loop::Loop" ref="a4a6ea4aeec32061bf86df9c9c32c5b24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apo::Loop::Loop </td>
<td>(</td>
<td class="paramname"></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___loop_8h_source.html#l00035">35</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
</div>
</div>
<a class="anchor" id="a75dc072e1d02ad2fe0cd56c6f3926ca3"></a><!-- doxytag: member="apo::Loop::Loop" ref="a75dc072e1d02ad2fe0cd56c6f3926ca3" args="(float frequency, void(*fptr)(void *)=NULL, void *data=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apo::Loop::Loop </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>frequency</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *)&nbsp;</td>
<td class="paramname"> <em>fptr</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>data</em> = <code>NULL</code></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="_a_p___loop_8cpp_source.html#l00024">24</a> of file <a class="el" href="_a_p___loop_8cpp_source.html">AP_Loop.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0dd58e809ffa1104cdd9e008918886aa"></a><!-- doxytag: member="apo::Loop::dt" ref="a0dd58e809ffa1104cdd9e008918886aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float apo::Loop::dt </td>
<td>(</td>
<td class="paramname"></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___loop_8h_source.html#l00050">50</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
</div>
</div>
<a class="anchor" id="aec93940b1c7ca50ebda47b7326c339ba"></a><!-- doxytag: member="apo::Loop::frequency" ref="aec93940b1c7ca50ebda47b7326c339ba" args="(float frequency)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apo::Loop::frequency </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>frequency</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___loop_8h_source.html#l00044">44</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6b88aae6e3f55895037ce5538f36076d"></a><!-- doxytag: member="apo::Loop::frequency" ref="a6b88aae6e3f55895037ce5538f36076d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t apo::Loop::frequency </td>
<td>(</td>
<td class="paramname"></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___loop_8h_source.html#l00041">41</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
</div>
</div>
<a class="anchor" id="af3017e1bf118c134e550cdda81c54d43"></a><!-- doxytag: member="apo::Loop::load" ref="af3017e1bf118c134e550cdda81c54d43" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t apo::Loop::load </td>
<td>(</td>
<td class="paramname"></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___loop_8h_source.html#l00053">53</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
</div>
</div>
<a class="anchor" id="a35a3d49da20cbad8a4dc863228632a57"></a><!-- doxytag: member="apo::Loop::subLoops" ref="a35a3d49da20cbad8a4dc863228632a57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_vector.html">Vector</a>&lt;<a class="el" href="classapo_1_1_loop.html">Loop</a> *&gt;&amp; apo::Loop::subLoops </td>
<td>(</td>
<td class="paramname"></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___loop_8h_source.html#l00038">38</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
</div>
</div>
<a class="anchor" id="af6f23eac39d89deb194d3e3f5cdd8df1"></a><!-- doxytag: member="apo::Loop::timeStamp" ref="af6f23eac39d89deb194d3e3f5cdd8df1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t apo::Loop::timeStamp </td>
<td>(</td>
<td class="paramname"></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___loop_8h_source.html#l00047">47</a> of file <a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9e46986a766ed78a9fff0667d9dcf813"></a><!-- doxytag: member="apo::Loop::update" ref="a9e46986a766ed78a9fff0667d9dcf813" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apo::Loop::update </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="_a_p___loop_8cpp_source.html#l00035">35</a> of file <a class="el" href="_a_p___loop_8cpp_source.html">AP_Loop.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/jgoppert/Projects/ap/libraries/AP_Common/<a class="el" href="_a_p___loop_8h_source.html">AP_Loop.h</a></li>
<li>/home/jgoppert/Projects/ap/libraries/AP_Common/<a class="el" href="_a_p___loop_8cpp_source.html">AP_Loop.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>