Myth/serial
1
0
Fork 0
mirror of https://github.com/wjwwood/serial.git synced 2026-01-22 11:44:53 +08:00
Code Issues Projects Releases Wiki Activity
serial/doc/0.2/serial_8h_source.html
William Woodall 756dec9a1e Uploading documentation for version 1.1.0
2012-10-24 00:15:53 -07:00

358 lines
33 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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>serial: include/serial/serial.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">serial
&#160;<span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">Cross-platformserialportlibraryforC++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">include/serial/serial.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="serial_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef SERIAL_H</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define SERIAL_H</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;limits&gt;</span>
<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;string.h&gt;</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include &lt;sstream&gt;</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &lt;exception&gt;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &lt;stdexcept&gt;</span>
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="serial_8h.html#a25cffc64bd967636d69d7c3c82af1030">00046</a> <span class="preprocessor">#define THROW(exceptionClass, message) throw exceptionClass(__FILE__, __LINE__, (message) )</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>
<a name="l00048"></a><a class="code" href="namespaceserial.html">00048</a> <span class="keyword">namespace </span>serial {
<a name="l00049"></a>00049
<a name="l00053"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">00053</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00054"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8af09eeaf7333d2feda0bd3d748d5e3123">00054</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8af09eeaf7333d2feda0bd3d748d5e3123">fivebits</a> = 5,
<a name="l00055"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a608eb93b80fe8531d626b4e588c5bc8b">00055</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a608eb93b80fe8531d626b4e588c5bc8b">sixbits</a> = 6,
<a name="l00056"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a7cf0a3607e326ff6736941008ea8174d">00056</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a7cf0a3607e326ff6736941008ea8174d">sevenbits</a> = 7,
<a name="l00057"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a47f14d952cf9bed6c3f7ae5985161990">00057</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a47f14d952cf9bed6c3f7ae5985161990">eightbits</a> = 8
<a name="l00058"></a>00058 } <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a>;
<a name="l00059"></a>00059
<a name="l00063"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">00063</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00064"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481a31cbb2b3cf0870d1a089d66295918416">00064</a> <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481a31cbb2b3cf0870d1a089d66295918416">parity_none</a> = 0,
<a name="l00065"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481affd8fd58edf7c25bab458cafaebecb10">00065</a> <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481affd8fd58edf7c25bab458cafaebecb10">parity_odd</a> = 1,
<a name="l00066"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481abe15d241d407528bc8a199b02301ed46">00066</a> <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481abe15d241d407528bc8a199b02301ed46">parity_even</a> = 2
<a name="l00067"></a>00067 } <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a>;
<a name="l00068"></a>00068
<a name="l00072"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">00072</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00073"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ab70806555a14cb43e5cc43f6f3d01157">00073</a> <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ab70806555a14cb43e5cc43f6f3d01157">stopbits_one</a> = 1,
<a name="l00074"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469abb25fb831662d361d99cf12fb0da45ec">00074</a> <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469abb25fb831662d361d99cf12fb0da45ec">stopbits_one_point_five</a>,
<a name="l00075"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ae0b1b8af1ece65afeacbe9fff198fa47">00075</a> <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ae0b1b8af1ece65afeacbe9fff198fa47">stopbits_two</a> = 2
<a name="l00076"></a>00076 } <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a>;
<a name="l00077"></a>00077
<a name="l00081"></a><a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">00081</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00082"></a><a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351a083bc02a6e8e7c6540a28654c0f95bb0">00082</a> <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351a083bc02a6e8e7c6540a28654c0f95bb0">flowcontrol_none</a> = 0,
<a name="l00083"></a><a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351ab3390af5eee11740af5e09d71ad419a6">00083</a> <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351ab3390af5eee11740af5e09d71ad419a6">flowcontrol_software</a>
<a name="l00084"></a>00084 } <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a>;
<a name="l00085"></a>00085
<a name="l00089"></a><a class="code" href="classserial_1_1_serial.html">00089</a> <span class="keyword">class </span><a class="code" href="classserial_1_1_serial.html">Serial</a> {
<a name="l00090"></a>00090 <span class="keyword">public</span>:
<a name="l00127"></a>00127 <a class="code" href="classserial_1_1_serial.html#a9222791dd26285a594cfc594f0879b10">Serial</a> (<span class="keyword">const</span> std::string &amp;port = <span class="stringliteral">&quot;&quot;</span>,
<a name="l00128"></a>00128 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> baudrate = 9600,
<a name="l00129"></a>00129 <span class="keywordtype">long</span> timeout = 0,
<a name="l00130"></a>00130 <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a> bytesize = <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a47f14d952cf9bed6c3f7ae5985161990">eightbits</a>,
<a name="l00131"></a>00131 <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a> parity = <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481a31cbb2b3cf0870d1a089d66295918416">parity_none</a>,
<a name="l00132"></a>00132 <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a> stopbits = <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ab70806555a14cb43e5cc43f6f3d01157">stopbits_one</a>,
<a name="l00133"></a>00133 <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a> flowcontrol = <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351a083bc02a6e8e7c6540a28654c0f95bb0">flowcontrol_none</a>);
<a name="l00134"></a>00134
<a name="l00136"></a>00136 <span class="keyword">virtual</span> <a class="code" href="classserial_1_1_serial.html#a5b32c394c0ff923a4ef1c13cfb20a6ba">~Serial</a> ();
<a name="l00137"></a>00137
<a name="l00151"></a>00151 <span class="keywordtype">void</span>
<a name="l00152"></a>00152 <a class="code" href="classserial_1_1_serial.html#af3644ed1a9d899b70e9d63bb9b808d62">open</a> ();
<a name="l00153"></a>00153
<a name="l00158"></a>00158 <span class="keywordtype">bool</span>
<a name="l00159"></a>00159 <a class="code" href="classserial_1_1_serial.html#af9895af496189f7f0aba7c097f5fa9c1">isOpen</a> () <span class="keyword">const</span>;
<a name="l00160"></a>00160
<a name="l00162"></a>00162 <span class="keywordtype">void</span>
<a name="l00163"></a>00163 <a class="code" href="classserial_1_1_serial.html#afbe59407e718bc3d22ea4a67b304db6c">close</a> ();
<a name="l00164"></a>00164
<a name="l00166"></a>00166 <span class="keywordtype">size_t</span>
<a name="l00167"></a>00167 <a class="code" href="classserial_1_1_serial.html#afafe25b2f3bb0809550abdc72c51a234">available</a>();
<a name="l00168"></a>00168
<a name="l00179"></a>00179 <span class="keywordtype">size_t</span>
<a name="l00180"></a>00180 <a class="code" href="classserial_1_1_serial.html#a2bcd2c76cdacf64928fcd7e9ec279ff1">read</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> size);
<a name="l00181"></a>00181 <span class="keywordtype">size_t</span>
<a name="l00182"></a>00182 <a class="code" href="classserial_1_1_serial.html#a2bcd2c76cdacf64928fcd7e9ec279ff1">read</a> (std::vector&lt;unsigned char&gt; &amp;buffer, <span class="keywordtype">size_t</span> size = 1);
<a name="l00183"></a>00183 <span class="keywordtype">size_t</span>
<a name="l00184"></a>00184 <a class="code" href="classserial_1_1_serial.html#a2bcd2c76cdacf64928fcd7e9ec279ff1">read</a> (std::string &amp;buffer, <span class="keywordtype">size_t</span> size = 1);
<a name="l00185"></a>00185 std::string
<a name="l00186"></a>00186 <a class="code" href="classserial_1_1_serial.html#a2bcd2c76cdacf64928fcd7e9ec279ff1">read</a> (<span class="keywordtype">size_t</span> size = 1);
<a name="l00187"></a>00187
<a name="l00197"></a>00197 <span class="keywordtype">size_t</span>
<a name="l00198"></a>00198 <a class="code" href="classserial_1_1_serial.html#a010b18ec545dfe1a7bb1c95be4bdaa54">readline</a> (std::string &amp;buffer,
<a name="l00199"></a>00199 <span class="keywordtype">size_t</span> size = 65536,
<a name="l00200"></a>00200 std::string eol = <span class="stringliteral">&quot;\n&quot;</span>);
<a name="l00201"></a>00201 std::string
<a name="l00202"></a>00202 <a class="code" href="classserial_1_1_serial.html#a010b18ec545dfe1a7bb1c95be4bdaa54">readline</a> (<span class="keywordtype">size_t</span> size = 65536,
<a name="l00203"></a>00203 std::string eol = <span class="stringliteral">&quot;\n&quot;</span>);
<a name="l00204"></a>00204
<a name="l00216"></a>00216 std::vector&lt;std::string&gt;
<a name="l00217"></a>00217 <a class="code" href="classserial_1_1_serial.html#a99f77b9bbdc128b6704cc59db77686c5">readlines</a> (<span class="keywordtype">size_t</span> size = 65536, std::string eol = <span class="stringliteral">&quot;\n&quot;</span>);
<a name="l00218"></a>00218
<a name="l00227"></a>00227 <span class="keywordtype">size_t</span>
<a name="l00228"></a>00228 <a class="code" href="classserial_1_1_serial.html#acd98ae129db624b664a5dd51f352d8f7">write</a> (<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">size_t</span> size);
<a name="l00229"></a>00229 <span class="keywordtype">size_t</span>
<a name="l00230"></a>00230 <a class="code" href="classserial_1_1_serial.html#acd98ae129db624b664a5dd51f352d8f7">write</a> (<span class="keyword">const</span> std::vector&lt;unsigned char&gt; &amp;data);
<a name="l00231"></a>00231 <span class="keywordtype">size_t</span>
<a name="l00232"></a>00232 <a class="code" href="classserial_1_1_serial.html#acd98ae129db624b664a5dd51f352d8f7">write</a> (<span class="keyword">const</span> std::string &amp;data);
<a name="l00233"></a>00233
<a name="l00242"></a>00242 <span class="keywordtype">void</span>
<a name="l00243"></a>00243 <a class="code" href="classserial_1_1_serial.html#acecb0a5102ae0c944fe4b78e4adf839a">setPort</a> (<span class="keyword">const</span> std::string &amp;port);
<a name="l00244"></a>00244
<a name="l00251"></a>00251 std::string
<a name="l00252"></a>00252 <a class="code" href="classserial_1_1_serial.html#ae95cd057e90258b1b3203ff8972a3567">getPort</a> () <span class="keyword">const</span>;
<a name="l00253"></a>00253
<a name="l00264"></a>00264 <span class="keywordtype">void</span>
<a name="l00265"></a>00265 <a class="code" href="classserial_1_1_serial.html#ab6ad13f872e31b9cf0af8cbeb9117cb0">setTimeout</a> (<span class="keywordtype">long</span> timeout);
<a name="l00266"></a>00266
<a name="l00271"></a>00271 <span class="keywordtype">long</span>
<a name="l00272"></a>00272 <a class="code" href="classserial_1_1_serial.html#a345cd91d7bd366e990e295f756d51112">getTimeout</a> () <span class="keyword">const</span>;
<a name="l00273"></a>00273
<a name="l00286"></a>00286 <span class="keywordtype">void</span>
<a name="l00287"></a>00287 <a class="code" href="classserial_1_1_serial.html#aec535895c800e3fd7c52d60b9f6b08a5">setBaudrate</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> baudrate);
<a name="l00288"></a>00288
<a name="l00297"></a>00297 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>
<a name="l00298"></a>00298 <a class="code" href="classserial_1_1_serial.html#acd0e5a25e4484d6f08fe02c1911ab5e0">getBaudrate</a> () <span class="keyword">const</span>;
<a name="l00299"></a>00299
<a name="l00308"></a>00308 <span class="keywordtype">void</span>
<a name="l00309"></a>00309 <a class="code" href="classserial_1_1_serial.html#adba430fd704f6898a5a1d99fd39a94fa">setBytesize</a> (<a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a> bytesize);
<a name="l00310"></a>00310
<a name="l00317"></a>00317 <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a>
<a name="l00318"></a>00318 <a class="code" href="classserial_1_1_serial.html#a4fce90ef7a9a46525efa373a94a1bfbd">getBytesize</a> () <span class="keyword">const</span>;
<a name="l00319"></a>00319
<a name="l00327"></a>00327 <span class="keywordtype">void</span>
<a name="l00328"></a>00328 <a class="code" href="classserial_1_1_serial.html#a1e1896aa59ec35ac5bd263b87614ef01">setParity</a> (<a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a> parity);
<a name="l00329"></a>00329
<a name="l00336"></a>00336 <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a>
<a name="l00337"></a>00337 <a class="code" href="classserial_1_1_serial.html#a89d876e1d3f0afadb0d6c21b08ed8931">getParity</a> () <span class="keyword">const</span>;
<a name="l00338"></a>00338
<a name="l00346"></a>00346 <span class="keywordtype">void</span>
<a name="l00347"></a>00347 <a class="code" href="classserial_1_1_serial.html#ab72284b5aab723b81013fb560bd6acc5">setStopbits</a> (<a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a> stopbits);
<a name="l00348"></a>00348
<a name="l00355"></a>00355 <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a>
<a name="l00356"></a>00356 <a class="code" href="classserial_1_1_serial.html#a42887bb76243bf6bbb3f69ff60f9792e">getStopbits</a> () <span class="keyword">const</span>;
<a name="l00357"></a>00357
<a name="l00366"></a>00366 <span class="keywordtype">void</span>
<a name="l00367"></a>00367 <a class="code" href="classserial_1_1_serial.html#ade41650d6bfe91b6432e5a0a60c03969">setFlowcontrol</a> (<a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a> flowcontrol);
<a name="l00368"></a>00368
<a name="l00375"></a>00375 <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a>
<a name="l00376"></a>00376 <a class="code" href="classserial_1_1_serial.html#acdc6da48a5434b936b1db20f36caf41f">getFlowcontrol</a> () <span class="keyword">const</span>;
<a name="l00377"></a>00377
<a name="l00379"></a>00379 <span class="keywordtype">void</span>
<a name="l00380"></a>00380 <a class="code" href="classserial_1_1_serial.html#a63b7abf172cad25bfc998b3b1f98310f">flush</a> ();
<a name="l00381"></a>00381
<a name="l00383"></a>00383 <span class="keywordtype">void</span>
<a name="l00384"></a>00384 <a class="code" href="classserial_1_1_serial.html#afa2c1f9114a37b7d140fc2292d1499b9">flushInput</a> ();
<a name="l00385"></a>00385
<a name="l00387"></a>00387 <span class="keywordtype">void</span>
<a name="l00388"></a>00388 <a class="code" href="classserial_1_1_serial.html#a256ee4bb93ab0e79d7a66b50f08dce53">flushOutput</a> ();
<a name="l00389"></a>00389
<a name="l00390"></a>00390 <span class="keywordtype">void</span>
<a name="l00391"></a>00391 <a class="code" href="classserial_1_1_serial.html#ade90ff8f03525ea6d7b702fcd0f336de">sendBreak</a> (<span class="keywordtype">int</span> duration);
<a name="l00392"></a>00392
<a name="l00393"></a>00393 <span class="keywordtype">void</span>
<a name="l00394"></a>00394 <a class="code" href="classserial_1_1_serial.html#a2a27912b1ca5cdad4a4aba7b9ddbc206">setBreak</a> (<span class="keywordtype">bool</span> level = <span class="keyword">true</span>);
<a name="l00395"></a>00395
<a name="l00396"></a>00396 <span class="keywordtype">void</span>
<a name="l00397"></a>00397 <a class="code" href="classserial_1_1_serial.html#ab43ddc05e5d69ff2778f698aa7062370">setRTS</a> (<span class="keywordtype">bool</span> level = <span class="keyword">true</span>);
<a name="l00398"></a>00398
<a name="l00399"></a>00399 <span class="keywordtype">void</span>
<a name="l00400"></a>00400 <a class="code" href="classserial_1_1_serial.html#ac9b0bbf613a5fe68f05d1d40181a1bb3">setDTR</a> (<span class="keywordtype">bool</span> level = <span class="keyword">true</span>);
<a name="l00401"></a>00401
<a name="l00402"></a>00402 <span class="keywordtype">bool</span>
<a name="l00403"></a>00403 <a class="code" href="classserial_1_1_serial.html#a809f048546c4c72b74e205139b97648c">getCTS</a> ();
<a name="l00404"></a>00404
<a name="l00405"></a>00405 <span class="keywordtype">bool</span>
<a name="l00406"></a>00406 <a class="code" href="classserial_1_1_serial.html#a6b9a0c485e1fe599dbb5e9e15b1a65d6">getDSR</a> ();
<a name="l00407"></a>00407
<a name="l00408"></a>00408 <span class="keywordtype">bool</span>
<a name="l00409"></a>00409 <a class="code" href="classserial_1_1_serial.html#afb96e6968f040c4bff7576095f4ba6e7">getRI</a> ();
<a name="l00410"></a>00410
<a name="l00411"></a>00411 <span class="keywordtype">bool</span>
<a name="l00412"></a>00412 <a class="code" href="classserial_1_1_serial.html#a9795a3e83e6745a14c64f657e68061fb">getCD</a> ();
<a name="l00413"></a>00413
<a name="l00414"></a>00414 <span class="keyword">private</span>:
<a name="l00415"></a>00415 <span class="comment">// Disable copy constructors</span>
<a name="l00416"></a>00416 <a class="code" href="classserial_1_1_serial.html#a9222791dd26285a594cfc594f0879b10">Serial</a>(<span class="keyword">const</span> <a class="code" href="classserial_1_1_serial.html">Serial</a>&amp;);
<a name="l00417"></a>00417 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="classserial_1_1_serial.html">Serial</a>&amp;);
<a name="l00418"></a>00418 <span class="keyword">const</span> <a class="code" href="classserial_1_1_serial.html">Serial</a>&amp; operator=(<a class="code" href="classserial_1_1_serial.html">Serial</a>);
<a name="l00419"></a>00419
<a name="l00420"></a>00420 std::string read_cache_;
<a name="l00421"></a>00421
<a name="l00422"></a>00422 <span class="comment">// Pimpl idiom, d_pointer</span>
<a name="l00423"></a>00423 <span class="keyword">class </span>SerialImpl;
<a name="l00424"></a>00424 SerialImpl *pimpl_;
<a name="l00425"></a>00425
<a name="l00426"></a>00426 <span class="comment">// Scoped Lock Classes</span>
<a name="l00427"></a>00427 <span class="keyword">class </span><a class="code" href="class_serial_1_1_scoped_read_lock.html">ScopedReadLock</a>;
<a name="l00428"></a>00428 <span class="keyword">class </span><a class="code" href="class_serial_1_1_scoped_write_lock.html">ScopedWriteLock</a>;
<a name="l00429"></a>00429
<a name="l00430"></a>00430 <span class="comment">// Read common function</span>
<a name="l00431"></a>00431 <span class="keywordtype">size_t</span>
<a name="l00432"></a>00432 read_ (<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> size);
<a name="l00433"></a>00433
<a name="l00434"></a>00434 };
<a name="l00435"></a>00435
<a name="l00436"></a><a class="code" href="classserial_1_1_serial_execption.html">00436</a> <span class="keyword">class </span><a class="code" href="classserial_1_1_serial_execption.html">SerialExecption</a> : <span class="keyword">public</span> std::exception
<a name="l00437"></a>00437 {
<a name="l00438"></a>00438 <span class="keyword">const</span> <span class="keywordtype">char</span>* e_what_;
<a name="l00439"></a>00439 <span class="keyword">public</span>:
<a name="l00440"></a><a class="code" href="classserial_1_1_serial_execption.html#aa4b29d2631c6a9a0ebe591834bbc4609">00440</a> <a class="code" href="classserial_1_1_serial_execption.html#aa4b29d2631c6a9a0ebe591834bbc4609">SerialExecption</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *description) : e_what_ (description) {}
<a name="l00441"></a>00441
<a name="l00442"></a><a class="code" href="classserial_1_1_serial_execption.html#a5cb17e5438390e95731ddd230524922d">00442</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classserial_1_1_serial_execption.html#a5cb17e5438390e95731ddd230524922d">what</a> () <span class="keyword">const</span> throw ()
<a name="l00443"></a>00443 {
<a name="l00444"></a>00444 std::stringstream ss;
<a name="l00445"></a>00445 ss &lt;&lt; <span class="stringliteral">&quot;SerialException &quot;</span> &lt;&lt; e_what_ &lt;&lt; <span class="stringliteral">&quot; failed.&quot;</span>;
<a name="l00446"></a>00446 <span class="keywordflow">return</span> ss.str ().c_str ();
<a name="l00447"></a>00447 }
<a name="l00448"></a>00448 };
<a name="l00449"></a>00449
<a name="l00450"></a><a class="code" href="classserial_1_1_i_o_exception.html">00450</a> <span class="keyword">class </span><a class="code" href="classserial_1_1_i_o_exception.html">IOException</a> : <span class="keyword">public</span> std::exception
<a name="l00451"></a>00451 {
<a name="l00452"></a>00452 std::string file_;
<a name="l00453"></a>00453 <span class="keywordtype">int</span> line_;
<a name="l00454"></a>00454 <span class="keyword">const</span> <span class="keywordtype">char</span>* e_what_;
<a name="l00455"></a>00455 <span class="keywordtype">int</span> errno_;
<a name="l00456"></a>00456 <span class="keyword">public</span>:
<a name="l00457"></a><a class="code" href="classserial_1_1_i_o_exception.html#acb2f2cf7a5cc8090945f6cbfcef3ef1e">00457</a> <span class="keyword">explicit</span> <a class="code" href="classserial_1_1_i_o_exception.html#acb2f2cf7a5cc8090945f6cbfcef3ef1e">IOException</a> (std::string file, <span class="keywordtype">int</span> line, <span class="keywordtype">int</span> errnum)
<a name="l00458"></a>00458 : file_(file), line_(line), e_what_ (strerror (errnum)), errno_(errnum) {}
<a name="l00459"></a><a class="code" href="classserial_1_1_i_o_exception.html#acc1d2c650832cc8127f2cd777072b2cd">00459</a> <span class="keyword">explicit</span> <a class="code" href="classserial_1_1_i_o_exception.html#acb2f2cf7a5cc8090945f6cbfcef3ef1e">IOException</a> (std::string file, <span class="keywordtype">int</span> line, <span class="keyword">const</span> <span class="keywordtype">char</span> * description)
<a name="l00460"></a>00460 : file_(file), line_(line), e_what_ (description), errno_(0) {}
<a name="l00461"></a><a class="code" href="classserial_1_1_i_o_exception.html#a026ae2e6abc57c6069915f0f8c701390">00461</a> <span class="keyword">virtual</span> <a class="code" href="classserial_1_1_i_o_exception.html#a026ae2e6abc57c6069915f0f8c701390">~IOException</a>() throw() {}
<a name="l00462"></a>00462
<a name="l00463"></a><a class="code" href="classserial_1_1_i_o_exception.html#a91d5ee5241dd49fb39e8e762564b6cc5">00463</a> <span class="keywordtype">int</span> <a class="code" href="classserial_1_1_i_o_exception.html#a91d5ee5241dd49fb39e8e762564b6cc5">getErrorNumber</a> () { <span class="keywordflow">return</span> errno_; }
<a name="l00464"></a>00464
<a name="l00465"></a><a class="code" href="classserial_1_1_i_o_exception.html#a5151f78cf0309db2c79f3dc4c779c774">00465</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classserial_1_1_i_o_exception.html#a5151f78cf0309db2c79f3dc4c779c774">what</a> () <span class="keyword">const</span> throw ()
<a name="l00466"></a>00466 {
<a name="l00467"></a>00467 std::stringstream ss;
<a name="l00468"></a>00468 <span class="keywordflow">if</span> (errno_ == 0)
<a name="l00469"></a>00469 ss &lt;&lt; <span class="stringliteral">&quot;IO Exception: &quot;</span> &lt;&lt; e_what_;
<a name="l00470"></a>00470 <span class="keywordflow">else</span>
<a name="l00471"></a>00471 ss &lt;&lt; <span class="stringliteral">&quot;IO Exception (&quot;</span> &lt;&lt; errno_ &lt;&lt; <span class="stringliteral">&quot;): &quot;</span> &lt;&lt; e_what_;
<a name="l00472"></a>00472 ss &lt;&lt; <span class="stringliteral">&quot;, file &quot;</span> &lt;&lt; file_ &lt;&lt; <span class="stringliteral">&quot;, line &quot;</span> &lt;&lt; line_ &lt;&lt; <span class="stringliteral">&quot;.&quot;</span>;
<a name="l00473"></a>00473 <span class="keywordflow">return</span> ss.str ().c_str ();
<a name="l00474"></a>00474 }
<a name="l00475"></a>00475 };
<a name="l00476"></a>00476
<a name="l00477"></a><a class="code" href="classserial_1_1_port_not_opened_exception.html">00477</a> <span class="keyword">class </span><a class="code" href="classserial_1_1_port_not_opened_exception.html">PortNotOpenedException</a> : <span class="keyword">public</span> std::exception
<a name="l00478"></a>00478 {
<a name="l00479"></a>00479 <span class="keyword">const</span> <span class="keywordtype">char</span> * e_what_;
<a name="l00480"></a>00480 <span class="keyword">public</span>:
<a name="l00481"></a><a class="code" href="classserial_1_1_port_not_opened_exception.html#acd2213fae864534eae6a580f74c5ab1b">00481</a> <a class="code" href="classserial_1_1_port_not_opened_exception.html#acd2213fae864534eae6a580f74c5ab1b">PortNotOpenedException</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * description) : e_what_ (description) {}
<a name="l00482"></a>00482
<a name="l00483"></a><a class="code" href="classserial_1_1_port_not_opened_exception.html#a314c997ecfe3990c4af147b247e8d9ce">00483</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classserial_1_1_port_not_opened_exception.html#a314c997ecfe3990c4af147b247e8d9ce">what</a> () <span class="keyword">const</span> throw ()
<a name="l00484"></a>00484 {
<a name="l00485"></a>00485 std::stringstream ss;
<a name="l00486"></a>00486 ss &lt;&lt; e_what_ &lt;&lt; <span class="stringliteral">&quot; called before port was opened.&quot;</span>;
<a name="l00487"></a>00487 <span class="keywordflow">return</span> ss.str ().c_str ();
<a name="l00488"></a>00488 }
<a name="l00489"></a>00489 };
<a name="l00490"></a>00490
<a name="l00491"></a><a class="code" href="classserial_1_1_serial_exception_base.html">00491</a> <span class="keyword">class </span><a class="code" href="classserial_1_1_serial_exception_base.html">SerialExceptionBase</a> : <span class="keyword">public</span> std::exception
<a name="l00492"></a>00492 {
<a name="l00493"></a>00493
<a name="l00494"></a>00494 };
<a name="l00495"></a>00495
<a name="l00496"></a>00496 } <span class="comment">// namespace serial</span>
<a name="l00497"></a>00497
<a name="l00498"></a>00498 <span class="preprocessor">#endif</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jun 9 2012 18:39:48 for serial by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink