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

328 lines
15 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: FastSerial 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>
<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>FastSerial Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="FastSerial" --><!-- doxytag: inherits="BetterStream" -->
<p><code>#include &lt;<a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>&gt;</code></p>
<p>Inherits <a class="el" href="class_better_stream.html">BetterStream</a>.</p>
<div class="dynheader">
Collaboration diagram for FastSerial:</div>
<div class="dyncontent">
<div class="center"><img src="class_fast_serial__coll__graph.png" border="0" usemap="#_fast_serial_coll__map" alt="Collaboration graph"/></div>
<map name="_fast_serial_coll__map" id="_fast_serial_coll__map">
<area shape="rect" id="node2" href="class_better_stream.html" title="BetterStream" alt="" coords="5,85,115,115"/><area shape="rect" id="node4" href="class_stream.html" title="Stream" alt="" coords="25,5,95,35"/><area shape="rect" id="node6" href="struct_fast_serial_1_1_buffer.html" title="FastSerial::Buffer" alt="" coords="139,85,269,115"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_fast_serial-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_fast_serial_1_1_buffer.html">Buffer</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_fast_serial.html#a9f20535e34fab50c1f771b9a41790219">FastSerial</a> (const uint8_t portNumber, volatile uint8_t *ubrrh, volatile uint8_t *ubrrl, volatile uint8_t *ucsra, volatile uint8_t *ucsrb, const uint8_t u2x, const uint8_t portEnableBits, const uint8_t portTxBits)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#a1ae3f5f5649d7a72daf2806a6ec1cf45">begin</a> (long baud)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#aca4c10e234de6ef56f255dbe8461f8b2">begin</a> (long baud, unsigned int rxSpace, unsigned int txSpace)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#a18dc7ab6584b8e01bed86d74d664e6fa">end</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#a3908f5db6a1e946207a4b92b7c0b9ee5">available</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#a6b63b52d3dedb762340675f0dbb29622">read</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#a1bb9d282cdf6abb37c95f3acc314d7a2">peek</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#a80a0f8852702174fc9f771da3713c933">flush</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_fast_serial.html#a8e41c9efa4f854ac6ffa0e178c1314e9">write</a> (uint8_t c)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_fast_serial_8h_source.html#l00089">89</a> of file <a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9f20535e34fab50c1f771b9a41790219"></a><!-- doxytag: member="FastSerial::FastSerial" ref="a9f20535e34fab50c1f771b9a41790219" args="(const uint8_t portNumber, volatile uint8_t *ubrrh, volatile uint8_t *ubrrl, volatile uint8_t *ucsra, volatile uint8_t *ucsrb, const uint8_t u2x, const uint8_t portEnableBits, const uint8_t portTxBits)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FastSerial::FastSerial </td>
<td>(</td>
<td class="paramtype">const uint8_t&nbsp;</td>
<td class="paramname"> <em>portNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">volatile uint8_t *&nbsp;</td>
<td class="paramname"> <em>ubrrh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">volatile uint8_t *&nbsp;</td>
<td class="paramname"> <em>ubrrl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">volatile uint8_t *&nbsp;</td>
<td class="paramname"> <em>ucsra</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">volatile uint8_t *&nbsp;</td>
<td class="paramname"> <em>ucsrb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t&nbsp;</td>
<td class="paramname"> <em>u2x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t&nbsp;</td>
<td class="paramname"> <em>portEnableBits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t&nbsp;</td>
<td class="paramname"> <em>portTxBits</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="_fast_serial_8cpp_source.html#l00056">56</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3908f5db6a1e946207a4b92b7c0b9ee5"></a><!-- doxytag: member="FastSerial::available" ref="a3908f5db6a1e946207a4b92b7c0b9ee5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FastSerial::available </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="class_stream.html#adb912146b71c46ce62d22412b819adcb">Stream</a>.</p>
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00163">163</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1ae3f5f5649d7a72daf2806a6ec1cf45"></a><!-- doxytag: member="FastSerial::begin" ref="a1ae3f5f5649d7a72daf2806a6ec1cf45" args="(long baud)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FastSerial::begin </td>
<td>(</td>
<td class="paramtype">long&nbsp;</td>
<td class="paramname"> <em>baud</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00082">82</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aca4c10e234de6ef56f255dbe8461f8b2"></a><!-- doxytag: member="FastSerial::begin" ref="aca4c10e234de6ef56f255dbe8461f8b2" args="(long baud, unsigned int rxSpace, unsigned int txSpace)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FastSerial::begin </td>
<td>(</td>
<td class="paramtype">long&nbsp;</td>
<td class="paramname"> <em>baud</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>rxSpace</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>txSpace</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00099">99</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a18dc7ab6584b8e01bed86d74d664e6fa"></a><!-- doxytag: member="FastSerial::end" ref="a18dc7ab6584b8e01bed86d74d664e6fa" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FastSerial::end </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00153">153</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a80a0f8852702174fc9f771da3713c933"></a><!-- doxytag: member="FastSerial::flush" ref="a80a0f8852702174fc9f771da3713c933" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FastSerial::flush </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00200">200</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1bb9d282cdf6abb37c95f3acc314d7a2"></a><!-- doxytag: member="FastSerial::peek" ref="a1bb9d282cdf6abb37c95f3acc314d7a2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FastSerial::peek </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00187">187</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6b63b52d3dedb762340675f0dbb29622"></a><!-- doxytag: member="FastSerial::read" ref="a6b63b52d3dedb762340675f0dbb29622" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FastSerial::read </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="class_stream.html#a4de9545ea7065d408c3efdb97f55dc2b">Stream</a>.</p>
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00171">171</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8e41c9efa4f854ac6ffa0e178c1314e9"></a><!-- doxytag: member="FastSerial::write" ref="a8e41c9efa4f854ac6ffa0e178c1314e9" args="(uint8_t c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FastSerial::write </td>
<td>(</td>
<td class="paramtype">uint8_t&nbsp;</td>
<td class="paramname"> <em>c</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="class_stream.html#a46cd2d80c276134f30300d619416d5c8">Stream</a>.</p>
<p>Definition at line <a class="el" href="_fast_serial_8cpp_source.html#l00220">220</a> of file <a class="el" href="_fast_serial_8cpp_source.html">FastSerial.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/jgoppert/Projects/ap/libraries/FastSerial/<a class="el" href="_fast_serial_8h_source.html">FastSerial.h</a></li>
<li>/home/jgoppert/Projects/ap/libraries/FastSerial/<a class="el" href="_fast_serial_8cpp_source.html">FastSerial.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