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

306 lines
14 KiB
HTML
Raw Normal View History

Added doxygen doc for library. git-svn-id: https://arducopter.googlecode.com/svn/trunk@1282 f9c3cf11-9bcb-44bc-f272-b75c42450872
2010-12-26 20:59:17 -04:00
<!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: AP_RcChannel Class 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 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> </div>
<div class="headertitle">
<h1>AP_RcChannel Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="AP_RcChannel" -->
<p>Object managing one RC channel.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for AP_RcChannel:</div>
<div class="dyncontent">
<div class="center"><img src="class_a_p___rc_channel__coll__graph.png" border="0" usemap="#_a_p___rc_channel_coll__map" alt="Collaboration graph"/></div>
<map name="_a_p___rc_channel_coll__map" id="_a_p___rc_channel_coll__map">
<area shape="rect" id="node2" href="class_a_p_m___r_c___class.html" title="APM_RC_Class" alt="" coords="5,5,120,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_a_p___rc_channel-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="class_a_p___rc_channel.html#a59d8e5ef7099eab747d84e58db50b8d4">AP_RcChannel</a> (const <a class="el" href="class_a_p_m___r_c___class.html">APM_RC_Class</a> &amp;rc, const uint16_t &amp;ch, const float &amp;scale, const uint16_t &amp;pwmMin, const uint16_t &amp;pwmNeutral, const uint16_t &amp;pwmMax, const uint16_t &amp;pwmDeadZone, const bool &amp;filter, const bool &amp;reverse)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#a725490da9c871958d654bb5801e84df0">readRadio</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#ae6caba4fc3de9e6e1eeaebcd42e5ff28">setPwm</a> (uint16_t pwm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#afeef294037ec90769e82e46d232cefb4">setPosition</a> (float position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#aa6e2d26454f7ba34896de1fe5999d339">mixRadio</a> (uint16_t infStart)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#aabf80a7612951952e267a1f65bbca40b">getPwm</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#a905e9e9bac80fda3b1e788d930e079f9">getPosition</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#a4fa8051ba8c8a26f04674c30dfd9f7b7">getNormalized</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_p___rc_channel.html#ae16cc18277ad6880e27cd726b2d39052">failSafe</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Object managing one RC channel. </p>
<p>Definition at line <a class="el" href="_a_p___rc_channel_8h_source.html#l00016">16</a> of file <a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a59d8e5ef7099eab747d84e58db50b8d4"></a><!-- doxytag: member="AP_RcChannel::AP_RcChannel" ref="a59d8e5ef7099eab747d84e58db50b8d4" args="(const APM_RC_Class &amp;rc, const uint16_t &amp;ch, const float &amp;scale, const uint16_t &amp;pwmMin, const uint16_t &amp;pwmNeutral, const uint16_t &amp;pwmMax, const uint16_t &amp;pwmDeadZone, const bool &amp;filter, const bool &amp;reverse)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AP_RcChannel::AP_RcChannel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_a_p_m___r_c___class.html">APM_RC_Class</a> &amp;&nbsp;</td>
<td class="paramname"> <em>rc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t &amp;&nbsp;</td>
<td class="paramname"> <em>ch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const float &amp;&nbsp;</td>
<td class="paramname"> <em>scale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t &amp;&nbsp;</td>
<td class="paramname"> <em>pwmMin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t &amp;&nbsp;</td>
<td class="paramname"> <em>pwmNeutral</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t &amp;&nbsp;</td>
<td class="paramname"> <em>pwmMax</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t &amp;&nbsp;</td>
<td class="paramname"> <em>pwmDeadZone</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool &amp;&nbsp;</td>
<td class="paramname"> <em>filter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool &amp;&nbsp;</td>
<td class="paramname"> <em>reverse</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor </p>
<p>Definition at line <a class="el" href="_a_p___rc_channel_8h_source.html#l00022">22</a> of file <a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae16cc18277ad6880e27cd726b2d39052"></a><!-- doxytag: member="AP_RcChannel::failSafe" ref="ae16cc18277ad6880e27cd726b2d39052" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AP_RcChannel::failSafe </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___rc_channel_8h_source.html#l00051">51</a> of file <a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4fa8051ba8c8a26f04674c30dfd9f7b7"></a><!-- doxytag: member="AP_RcChannel::getNormalized" ref="a4fa8051ba8c8a26f04674c30dfd9f7b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float AP_RcChannel::getNormalized </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___rc_channel_8h_source.html#l00048">48</a> of file <a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a>.</p>
</div>
</div>
<a class="anchor" id="a905e9e9bac80fda3b1e788d930e079f9"></a><!-- doxytag: member="AP_RcChannel::getPosition" ref="a905e9e9bac80fda3b1e788d930e079f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float AP_RcChannel::getPosition </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___rc_channel_8h_source.html#l00047">47</a> of file <a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a>.</p>
</div>
</div>
<a class="anchor" id="aabf80a7612951952e267a1f65bbca40b"></a><!-- doxytag: member="AP_RcChannel::getPwm" ref="aabf80a7612951952e267a1f65bbca40b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t AP_RcChannel::getPwm </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___rc_channel_8h_source.html#l00046">46</a> of file <a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa6e2d26454f7ba34896de1fe5999d339"></a><!-- doxytag: member="AP_RcChannel::mixRadio" ref="aa6e2d26454f7ba34896de1fe5999d339" args="(uint16_t infStart)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_RcChannel::mixRadio </td>
<td>(</td>
<td class="paramtype">uint16_t&nbsp;</td>
<td class="paramname"> <em>infStart</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___rc_channel_8cpp_source.html#l00059">59</a> of file <a class="el" href="_a_p___rc_channel_8cpp_source.html">AP_RcChannel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a725490da9c871958d654bb5801e84df0"></a><!-- doxytag: member="AP_RcChannel::readRadio" ref="a725490da9c871958d654bb5801e84df0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_RcChannel::readRadio </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___rc_channel_8cpp_source.html#l00017">17</a> of file <a class="el" href="_a_p___rc_channel_8cpp_source.html">AP_RcChannel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afeef294037ec90769e82e46d232cefb4"></a><!-- doxytag: member="AP_RcChannel::setPosition" ref="afeef294037ec90769e82e46d232cefb4" args="(float position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_RcChannel::setPosition </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>position</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___rc_channel_8cpp_source.html#l00053">53</a> of file <a class="el" href="_a_p___rc_channel_8cpp_source.html">AP_RcChannel.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae6caba4fc3de9e6e1eeaebcd42e5ff28"></a><!-- doxytag: member="AP_RcChannel::setPwm" ref="ae6caba4fc3de9e6e1eeaebcd42e5ff28" args="(uint16_t pwm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AP_RcChannel::setPwm </td>
<td>(</td>
<td class="paramtype">uint16_t&nbsp;</td>
<td class="paramname"> <em>pwm</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_a_p___rc_channel_8cpp_source.html#l00024">24</a> of file <a class="el" href="_a_p___rc_channel_8cpp_source.html">AP_RcChannel.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_RcChannel/<a class="el" href="_a_p___rc_channel_8h_source.html">AP_RcChannel.h</a></li>
<li>/home/jgoppert/Projects/ap/libraries/AP_RcChannel/<a class="el" href="_a_p___rc_channel_8cpp_source.html">AP_RcChannel.cpp</a></li>
</ul>
</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>