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

129 lines
5.6 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: Stream 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>Stream Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Stream" -->
<p><code>#include &lt;<a class="el" href="_w_program_8h_source.html">WProgram.h</a>&gt;</code></p>
<p>Inherited by <a class="el" href="class_better_stream.html">BetterStream</a>.</p>
<p><a href="class_stream-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a46cd2d80c276134f30300d619416d5c8">write</a> (uint8_t val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#adb912146b71c46ce62d22412b819adcb">available</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a4de9545ea7065d408c3efdb97f55dc2b">read</a> (void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_w_program_8h_source.html#l00005">5</a> of file <a class="el" href="_w_program_8h_source.html">WProgram.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adb912146b71c46ce62d22412b819adcb"></a><!-- doxytag: member="Stream::available" ref="adb912146b71c46ce62d22412b819adcb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Stream::available </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="class_fast_serial.html#a3908f5db6a1e946207a4b92b7c0b9ee5">FastSerial</a>.</p>
<p>Definition at line <a class="el" href="test_8cpp_source.html#l00042">42</a> of file <a class="el" href="test_8cpp_source.html">test.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4de9545ea7065d408c3efdb97f55dc2b"></a><!-- doxytag: member="Stream::read" ref="a4de9545ea7065d408c3efdb97f55dc2b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Stream::read </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="class_fast_serial.html#a6b63b52d3dedb762340675f0dbb29622">FastSerial</a>.</p>
<p>Definition at line <a class="el" href="test_8cpp_source.html#l00048">48</a> of file <a class="el" href="test_8cpp_source.html">test.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a46cd2d80c276134f30300d619416d5c8"></a><!-- doxytag: member="Stream::write" ref="a46cd2d80c276134f30300d619416d5c8" args="(uint8_t val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Stream::write </td>
<td>(</td>
<td class="paramtype">uint8_t&nbsp;</td>
<td class="paramname"> <em>val</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="class_fast_serial.html#a8e41c9efa4f854ac6ffa0e178c1314e9">FastSerial</a>.</p>
<p>Definition at line <a class="el" href="test_8cpp_source.html#l00036">36</a> of file <a class="el" href="test_8cpp_source.html">test.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/jgoppert/Projects/ap/libraries/APM_BinComm/test/<a class="el" href="_w_program_8h_source.html">WProgram.h</a></li>
<li>/home/jgoppert/Projects/ap/libraries/APM_BinComm/test/<a class="el" href="test_8cpp_source.html">test.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>