<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceflexiport.html">flexiport</a>::<a class="el" href="classflexiport_1_1SerialPort.html">SerialPort</a>
</div>
</div>
<div class="contents">
<h1>flexiport::SerialPort Class Reference</h1><!-- doxytag: class="flexiport::SerialPort" --><!-- doxytag: inherits="flexiport::Port" -->
<p>Serial implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="serialport_8h_source.html">serialport.h</a>></code></p>
<p>Inherits <a class="el" href="classflexiport_1_1Port.html">flexiport::Port</a>.</p>
<p><a href="classflexiport_1_1SerialPort-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00d69cf7139cf10a2b4f132fa99edf3a"></a><!-- doxytag: member="flexiport::SerialPort::Open" ref="a00d69cf7139cf10a2b4f132fa99edf3a" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a00d69cf7139cf10a2b4f132fa99edf3a">Open</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a288718bdb3eec56eda141a39f8ab5582"></a><!-- doxytag: member="flexiport::SerialPort::Close" ref="a288718bdb3eec56eda141a39f8ab5582" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a288718bdb3eec56eda141a39f8ab5582">Close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea5b5dbaa028e3111f16d73e8bebb9bd"></a><!-- doxytag: member="flexiport::SerialPort::Read" ref="aea5b5dbaa028e3111f16d73e8bebb9bd" args="(void *const buffer, size_t count)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#aea5b5dbaa028e3111f16d73e8bebb9bd">Read</a> (void *const buffer, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read from the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef912e0013bd23230b8d98d91c79d4ee"></a><!-- doxytag: member="flexiport::SerialPort::ReadFull" ref="aef912e0013bd23230b8d98d91c79d4ee" args="(void *const buffer, size_t count)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#aef912e0013bd23230b8d98d91c79d4ee">ReadFull</a> (void *const buffer, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the requested quantity of data from the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8200624c16fcb8f48cbfdb0c3ab300a0"></a><!-- doxytag: member="flexiport::SerialPort::BytesAvailable" ref="a8200624c16fcb8f48cbfdb0c3ab300a0" args="()" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a8200624c16fcb8f48cbfdb0c3ab300a0">BytesAvailable</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of bytes waiting to be read at the port. Returns immediatly. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a79b0737a60ad398d814f14dd2f6b74c6">BytesAvailableWait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of bytes waiting after blocking for the timeout. <a href="#a79b0737a60ad398d814f14dd2f6b74c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a788122a2d52b2df1d7aff1e426c58761"></a><!-- doxytag: member="flexiport::SerialPort::Write" ref="a788122a2d52b2df1d7aff1e426c58761" args="(const void *const buffer, size_t count)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a788122a2d52b2df1d7aff1e426c58761">Write</a> (const void *const buffer, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write data to the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a0fc093cab502658288fbdb2385025f"></a><!-- doxytag: member="flexiport::SerialPort::Flush" ref="a5a0fc093cab502658288fbdb2385025f" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a5a0fc093cab502658288fbdb2385025f">Flush</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush the port's input and output buffers, discarding all data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97fe18bd3848379cb4226ea5c4ddd0a1"></a><!-- doxytag: member="flexiport::SerialPort::Drain" ref="a97fe18bd3848379cb4226ea5c4ddd0a1" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a97fe18bd3848379cb4226ea5c4ddd0a1">Drain</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Drain the port's input and output buffers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a919a46a3d13f45568fc191a9d5116a1e"></a><!-- doxytag: member="flexiport::SerialPort::GetStatus" ref="a919a46a3d13f45568fc191a9d5116a1e" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a919a46a3d13f45568fc191a9d5116a1e">GetStatus</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status of the port (type, device, etc). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6f8766ed97486b8b194aa0eb89299fc"></a><!-- doxytag: member="flexiport::SerialPort::SetTimeout" ref="ae6f8766ed97486b8b194aa0eb89299fc" args="(Timeout timeout)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#ae6f8766ed97486b8b194aa0eb89299fc">SetTimeout</a> (<a class="el" href="classflexiport_1_1Timeout.html">Timeout</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the timeout value in milliseconds. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6153938efae9a02e92ccb38db9711874"></a><!-- doxytag: member="flexiport::SerialPort::SetCanRead" ref="a6153938efae9a02e92ccb38db9711874" args="(bool canRead)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a6153938efae9a02e92ccb38db9711874">SetCanRead</a> (bool canRead)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the read permissions of the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09985c4827f44ea4127ec384a8222f08"></a><!-- doxytag: member="flexiport::SerialPort::SetCanWrite" ref="a09985c4827f44ea4127ec384a8222f08" args="(bool canWrite)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a09985c4827f44ea4127ec384a8222f08">SetCanWrite</a> (bool canWrite)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the write permissions of the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb13327025bf85ac0a5e3f4a2fe2b1d6"></a><!-- doxytag: member="flexiport::SerialPort::IsOpen" ref="adb13327025bf85ac0a5e3f4a2fe2b1d6" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#adb13327025bf85ac0a5e3f4a2fe2b1d6">IsOpen</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the port is open. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dc22754c7da00f31a914789eb1c7c0f"></a><!-- doxytag: member="flexiport::SerialPort::SetBaudRate" ref="a9dc22754c7da00f31a914789eb1c7c0f" args="(unsigned int baud)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a9dc22754c7da00f31a914789eb1c7c0f">SetBaudRate</a> (unsigned int baud)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the baud rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ecc58360eee564e23ec279fdf006457"></a><!-- doxytag: member="flexiport::SerialPort::GetBaudRate" ref="a8ecc58360eee564e23ec279fdf006457" args="() const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1SerialPort.html#a8ecc58360eee564e23ec279fdf006457">GetBaudRate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current baud rate. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Serial implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class. </p>
<p>See the <a class="el" href="classflexiport_1_1Port.html">Port</a> class documentation for how to use the common API.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Under Windows, the timeout resolution is milliseconds, not microseconds. The timeout value will be rounded to the nearest millisecond when used.</dd></dl>
<dl class="user"><dt><b>Options</b></dt><dd><ul>
<li>device <string><ul>
<li>Serial device to use.</li>
<li>Default: /dev/ttyS0</li>
</ul>
</li>
<li>parity none|even|odd<ul>
<li>Data parity.</li>
<li>Default: none</li>
</ul>
</li>
<li>baud <integer><ul>
<li>Baud rate. Valid values are 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 34800, 57600, 115200, 230400.</li>
<li>Default: 9600</li>
</ul>
</li>
<li>databits <integer><ul>
<li>Default: 8</li>
</ul>
</li>
<li>stopbits 1|2<ul>
<li>Number of stop bits: 1 or 2.</li>
<li>Default: 1</li>
</ul>
</li>
<li>hwflowctrl<ul>
<li>Turn hardware flow control on.</li>
<li>Default: off </li>
</ul>
</li>
</ul>
</dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a79b0737a60ad398d814f14dd2f6b74c6"></a><!-- doxytag: member="flexiport::SerialPort::BytesAvailableWait" ref="a79b0737a60ad398d814f14dd2f6b74c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t flexiport::SerialPort::BytesAvailableWait </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of bytes waiting after blocking for the timeout. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Currently this function performs differently under Win32. It will block for the entire length of the timeout if data is not immediatly available. This will be fixed in the future. </dd></dl>
<p>Implements <a class="el" href="classflexiport_1_1Port.html#a2967c49bd23f95e7f325212c7947acd0">flexiport::Port</a>.</p>
<p>References <a class="el" href="serialport_8cpp_source.html#l00549">BytesAvailable()</a>, and <a class="el" href="port_8h_source.html#l00281">flexiport::Port::IsBlocking()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="serialport_8h_source.html">serialport.h</a></li>
<li>serialport.cpp</li>
</ul>
</div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
