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/docs/v1.0/serial_8h_source.html

392 lines
37 KiB
HTML
Raw Normal View History

Adding proposed v1.0 api to gh-pages
2012-05-02 00:40:56 -05: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"/>
<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-platform serial port library for C++</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>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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__, \</span>
<a name="l00047"></a>00047 <span class="preprocessor">__LINE__, (message) )</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a><a class="code" href="namespaceserial.html">00049</a> <span class="keyword">namespace </span>serial {
<a name="l00050"></a>00050
<a name="l00054"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">00054</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00055"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8af09eeaf7333d2feda0bd3d748d5e3123">00055</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8af09eeaf7333d2feda0bd3d748d5e3123">fivebits</a> = 5,
<a name="l00056"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a608eb93b80fe8531d626b4e588c5bc8b">00056</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a608eb93b80fe8531d626b4e588c5bc8b">sixbits</a> = 6,
<a name="l00057"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a7cf0a3607e326ff6736941008ea8174d">00057</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a7cf0a3607e326ff6736941008ea8174d">sevenbits</a> = 7,
<a name="l00058"></a><a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a47f14d952cf9bed6c3f7ae5985161990">00058</a> <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a47f14d952cf9bed6c3f7ae5985161990">eightbits</a> = 8
<a name="l00059"></a>00059 } <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a>;
<a name="l00060"></a>00060
<a name="l00064"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">00064</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00065"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481a31cbb2b3cf0870d1a089d66295918416">00065</a> <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481a31cbb2b3cf0870d1a089d66295918416">parity_none</a> = 0,
<a name="l00066"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481affd8fd58edf7c25bab458cafaebecb10">00066</a> <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481affd8fd58edf7c25bab458cafaebecb10">parity_odd</a> = 1,
<a name="l00067"></a><a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481abe15d241d407528bc8a199b02301ed46">00067</a> <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481abe15d241d407528bc8a199b02301ed46">parity_even</a> = 2
<a name="l00068"></a>00068 } <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a>;
<a name="l00069"></a>00069
<a name="l00073"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">00073</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00074"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ab70806555a14cb43e5cc43f6f3d01157">00074</a> <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ab70806555a14cb43e5cc43f6f3d01157">stopbits_one</a> = 1,
<a name="l00075"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469abb25fb831662d361d99cf12fb0da45ec">00075</a> <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469abb25fb831662d361d99cf12fb0da45ec">stopbits_one_point_five</a>,
<a name="l00076"></a><a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ae0b1b8af1ece65afeacbe9fff198fa47">00076</a> <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ae0b1b8af1ece65afeacbe9fff198fa47">stopbits_two</a> = 2
<a name="l00077"></a>00077 } <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a>;
<a name="l00078"></a>00078
<a name="l00082"></a><a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">00082</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00083"></a><a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351a083bc02a6e8e7c6540a28654c0f95bb0">00083</a> <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351a083bc02a6e8e7c6540a28654c0f95bb0">flowcontrol_none</a> = 0,
<a name="l00084"></a><a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351ab3390af5eee11740af5e09d71ad419a6">00084</a> <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351ab3390af5eee11740af5e09d71ad419a6">flowcontrol_software</a>
<a name="l00085"></a>00085 } <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a>;
<a name="l00086"></a>00086
<a name="l00091"></a><a class="code" href="structserial_1_1timeout__t.html">00091</a> <span class="keyword">struct </span><a class="code" href="structserial_1_1timeout__t.html">timeout_t</a> {
<a name="l00092"></a><a class="code" href="structserial_1_1timeout__t.html#a66a9f8ddc185a5c94b95fa2b0b7e6fbc">00092</a> <a class="code" href="structserial_1_1timeout__t.html#a66a9f8ddc185a5c94b95fa2b0b7e6fbc">timeout_t</a> (<span class="keywordtype">long</span> inter_byte_timeout_=0, <span class="keywordtype">long</span> read_timeout_constant_=0,
<a name="l00093"></a>00093 <span class="keywordtype">long</span> read_timeout_multiplier_=0, <span class="keywordtype">long</span> write_timeout_constant_=0,
<a name="l00094"></a>00094 <span class="keywordtype">long</span> write_timeout_multiplier_=0)
<a name="l00095"></a>00095 : <a class="code" href="structserial_1_1timeout__t.html#abb885cffadb5ee57c6689d5a3c50dfad">inter_byte_timeout</a>(inter_byte_timeout_),
<a name="l00096"></a>00096 <a class="code" href="structserial_1_1timeout__t.html#a2fc1dbde1ba635636379085f4e5f58fe">read_timeout_constant</a>(read_timeout_constant_),
<a name="l00097"></a>00097 <a class="code" href="structserial_1_1timeout__t.html#a548b76a924a2f8d5c902130cb587e6bb">read_timeout_multiplier</a>(read_timeout_multiplier_),
<a name="l00098"></a>00098 <a class="code" href="structserial_1_1timeout__t.html#acd6e36245118512785400915828cfd32">write_timeout_constant</a>(write_timeout_constant_),
<a name="l00099"></a>00099 <a class="code" href="structserial_1_1timeout__t.html#af43380c4255a9b8669970532048c4dfc">write_timeout_multiplier</a>(write_timeout_multiplier_)
<a name="l00100"></a>00100 {}
<a name="l00102"></a><a class="code" href="structserial_1_1timeout__t.html#abb885cffadb5ee57c6689d5a3c50dfad">00102</a> <span class="keywordtype">long</span> <a class="code" href="structserial_1_1timeout__t.html#abb885cffadb5ee57c6689d5a3c50dfad">inter_byte_timeout</a>;
<a name="l00104"></a><a class="code" href="structserial_1_1timeout__t.html#a2fc1dbde1ba635636379085f4e5f58fe">00104</a> <span class="keywordtype">long</span> <a class="code" href="structserial_1_1timeout__t.html#a2fc1dbde1ba635636379085f4e5f58fe">read_timeout_constant</a>;
<a name="l00108"></a><a class="code" href="structserial_1_1timeout__t.html#a548b76a924a2f8d5c902130cb587e6bb">00108</a> <span class="keywordtype">long</span> <a class="code" href="structserial_1_1timeout__t.html#a548b76a924a2f8d5c902130cb587e6bb">read_timeout_multiplier</a>;
<a name="l00110"></a><a class="code" href="structserial_1_1timeout__t.html#acd6e36245118512785400915828cfd32">00110</a> <span class="keywordtype">long</span> <a class="code" href="structserial_1_1timeout__t.html#acd6e36245118512785400915828cfd32">write_timeout_constant</a>;
<a name="l00114"></a><a class="code" href="structserial_1_1timeout__t.html#af43380c4255a9b8669970532048c4dfc">00114</a> <span class="keywordtype">long</span> <a class="code" href="structserial_1_1timeout__t.html#af43380c4255a9b8669970532048c4dfc">write_timeout_multiplier</a>;
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116
<a name="l00120"></a><a class="code" href="classserial_1_1_serial.html">00120</a> <span class="keyword">class </span><a class="code" href="classserial_1_1_serial.html">Serial</a> {
<a name="l00121"></a>00121 <span class="keyword">public</span>:
<a name="l00148"></a>00148 <a class="code" href="classserial_1_1_serial.html#a5c7bf8dcebe4dcf4269641fcd6d773e7">Serial</a> (<span class="keyword">const</span> std::string &amp;port = <span class="stringliteral">&quot;&quot;</span>,
<a name="l00149"></a>00149 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> baudrate = 9600,
<a name="l00150"></a>00150 <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a> bytesize = <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8a47f14d952cf9bed6c3f7ae5985161990">eightbits</a>,
<a name="l00151"></a>00151 <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a> parity = <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481a31cbb2b3cf0870d1a089d66295918416">parity_none</a>,
<a name="l00152"></a>00152 <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a> stopbits = <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469ab70806555a14cb43e5cc43f6f3d01157">stopbits_one</a>,
<a name="l00153"></a>00153 <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a> flowcontrol = <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351a083bc02a6e8e7c6540a28654c0f95bb0">flowcontrol_none</a>);
<a name="l00154"></a>00154
<a name="l00156"></a>00156 <span class="keyword">virtual</span> <a class="code" href="classserial_1_1_serial.html#a5b32c394c0ff923a4ef1c13cfb20a6ba">~Serial</a> ();
<a name="l00157"></a>00157
<a name="l00171"></a>00171 <span class="keywordtype">void</span>
<a name="l00172"></a>00172 <a class="code" href="classserial_1_1_serial.html#af3644ed1a9d899b70e9d63bb9b808d62">open</a> ();
<a name="l00173"></a>00173
<a name="l00178"></a>00178 <span class="keywordtype">bool</span>
<a name="l00179"></a>00179 <a class="code" href="classserial_1_1_serial.html#af9895af496189f7f0aba7c097f5fa9c1">isOpen</a> () <span class="keyword">const</span>;
<a name="l00180"></a>00180
<a name="l00182"></a>00182 <span class="keywordtype">void</span>
<a name="l00183"></a>00183 <a class="code" href="classserial_1_1_serial.html#afbe59407e718bc3d22ea4a67b304db6c">close</a> ();
<a name="l00184"></a>00184
<a name="l00186"></a>00186 <span class="keywordtype">size_t</span>
<a name="l00187"></a>00187 <a class="code" href="classserial_1_1_serial.html#afafe25b2f3bb0809550abdc72c51a234">available</a> ();
<a name="l00188"></a>00188
<a name="l00214"></a>00214 <span class="keywordtype">size_t</span>
<a name="l00215"></a>00215 <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="l00216"></a>00216
<a name="l00225"></a>00225 <span class="keywordtype">size_t</span>
<a name="l00226"></a>00226 <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="l00227"></a>00227
<a name="l00236"></a>00236 <span class="keywordtype">size_t</span>
<a name="l00237"></a>00237 <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="l00238"></a>00238
<a name="l00246"></a>00246 std::string
<a name="l00247"></a>00247 <a class="code" href="classserial_1_1_serial.html#a2bcd2c76cdacf64928fcd7e9ec279ff1">read</a> (<span class="keywordtype">size_t</span> size = 1);
<a name="l00248"></a>00248
<a name="l00259"></a>00259 <span class="keywordtype">size_t</span>
<a name="l00260"></a>00260 <a class="code" href="classserial_1_1_serial.html#a010b18ec545dfe1a7bb1c95be4bdaa54">readline</a> (std::string &amp;buffer, <span class="keywordtype">size_t</span> size = 65536, std::string eol = <span class="stringliteral">&quot;\n&quot;</span>);
<a name="l00261"></a>00261
<a name="l00271"></a>00271 std::string
<a name="l00272"></a>00272 <a class="code" href="classserial_1_1_serial.html#a010b18ec545dfe1a7bb1c95be4bdaa54">readline</a> (<span class="keywordtype">size_t</span> size = 65536, std::string eol = <span class="stringliteral">&quot;\n&quot;</span>);
<a name="l00273"></a>00273
<a name="l00285"></a>00285 std::vector&lt;std::string&gt;
<a name="l00286"></a>00286 <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="l00287"></a>00287
<a name="l00299"></a>00299 <span class="keywordtype">size_t</span>
<a name="l00300"></a>00300 <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="l00301"></a>00301
<a name="l00310"></a>00310 <span class="keywordtype">size_t</span>
<a name="l00311"></a>00311 <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="l00312"></a>00312
<a name="l00321"></a>00321 <span class="keywordtype">size_t</span>
<a name="l00322"></a>00322 <a class="code" href="classserial_1_1_serial.html#acd98ae129db624b664a5dd51f352d8f7">write</a> (<span class="keyword">const</span> std::string &amp;data);
<a name="l00323"></a>00323
<a name="l00332"></a>00332 <span class="keywordtype">void</span>
<a name="l00333"></a>00333 <a class="code" href="classserial_1_1_serial.html#acecb0a5102ae0c944fe4b78e4adf839a">setPort</a> (<span class="keyword">const</span> std::string &amp;port);
<a name="l00334"></a>00334
<a name="l00341"></a>00341 std::string
<a name="l00342"></a>00342 <a class="code" href="classserial_1_1_serial.html#ae95cd057e90258b1b3203ff8972a3567">getPort</a> () <span class="keyword">const</span>;
<a name="l00343"></a>00343
<a name="l00365"></a>00365 <span class="keywordtype">void</span>
<a name="l00366"></a>00366 <a class="code" href="classserial_1_1_serial.html#acb18e62d340695e2f7ab158633863b20">setTimeout</a> (<a class="code" href="structserial_1_1timeout__t.html">timeout_t</a> &amp;timeout);
<a name="l00367"></a>00367
<a name="l00369"></a>00369 <span class="keywordtype">void</span>
<a name="l00370"></a><a class="code" href="classserial_1_1_serial.html#a1316ecb01d266e2698317c390ff7af80">00370</a> <a class="code" href="classserial_1_1_serial.html#acb18e62d340695e2f7ab158633863b20">setTimeout</a> (<span class="keywordtype">long</span> inter_byte_timeout, <span class="keywordtype">long</span> read_timeout_constant,
<a name="l00371"></a>00371 <span class="keywordtype">long</span> read_timeout_multiplier, <span class="keywordtype">long</span> write_timeout_constant,
<a name="l00372"></a>00372 <span class="keywordtype">long</span> write_timeout_multiplier)
<a name="l00373"></a>00373 {
<a name="l00374"></a>00374 <a class="code" href="structserial_1_1timeout__t.html">timeout_t</a> timeout(inter_byte_timeout, read_timeout_constant,
<a name="l00375"></a>00375 read_timeout_multiplier, write_timeout_constant,
<a name="l00376"></a>00376 write_timeout_multiplier);
<a name="l00377"></a>00377 <span class="keywordflow">return</span> <a class="code" href="classserial_1_1_serial.html#acb18e62d340695e2f7ab158633863b20">setTimeout</a>(timeout);
<a name="l00378"></a>00378 }
<a name="l00379"></a>00379
<a name="l00387"></a>00387 <a class="code" href="structserial_1_1timeout__t.html">timeout_t</a>
<a name="l00388"></a>00388 <a class="code" href="classserial_1_1_serial.html#a655e62319e089961aa02fb47fbc1b198">getTimeout</a> () <span class="keyword">const</span>;
<a name="l00389"></a>00389
<a name="l00402"></a>00402 <span class="keywordtype">void</span>
<a name="l00403"></a>00403 <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="l00404"></a>00404
<a name="l00413"></a>00413 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>
<a name="l00414"></a>00414 <a class="code" href="classserial_1_1_serial.html#acd0e5a25e4484d6f08fe02c1911ab5e0">getBaudrate</a> () <span class="keyword">const</span>;
<a name="l00415"></a>00415
<a name="l00424"></a>00424 <span class="keywordtype">void</span>
<a name="l00425"></a>00425 <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="l00426"></a>00426
<a name="l00433"></a>00433 <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a>
<a name="l00434"></a>00434 <a class="code" href="classserial_1_1_serial.html#a4fce90ef7a9a46525efa373a94a1bfbd">getBytesize</a> () <span class="keyword">const</span>;
<a name="l00435"></a>00435
<a name="l00443"></a>00443 <span class="keywordtype">void</span>
<a name="l00444"></a>00444 <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="l00445"></a>00445
<a name="l00452"></a>00452 <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a>
<a name="l00453"></a>00453 <a class="code" href="classserial_1_1_serial.html#a89d876e1d3f0afadb0d6c21b08ed8931">getParity</a> () <span class="keyword">const</span>;
<a name="l00454"></a>00454
<a name="l00462"></a>00462 <span class="keywordtype">void</span>
<a name="l00463"></a>00463 <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="l00464"></a>00464
<a name="l00471"></a>00471 <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a>
<a name="l00472"></a>00472 <a class="code" href="classserial_1_1_serial.html#a42887bb76243bf6bbb3f69ff60f9792e">getStopbits</a> () <span class="keyword">const</span>;
<a name="l00473"></a>00473
<a name="l00482"></a>00482 <span class="keywordtype">void</span>
<a name="l00483"></a>00483 <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="l00484"></a>00484
<a name="l00491"></a>00491 <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a>
<a name="l00492"></a>00492 <a class="code" href="classserial_1_1_serial.html#acdc6da48a5434b936b1db20f36caf41f">getFlowcontrol</a> () <span class="keyword">const</span>;
<a name="l00493"></a>00493
<a name="l00495"></a>00495 <span class="keywordtype">void</span>
<a name="l00496"></a>00496 <a class="code" href="classserial_1_1_serial.html#a63b7abf172cad25bfc998b3b1f98310f">flush</a> ();
<a name="l00497"></a>00497
<a name="l00499"></a>00499 <span class="keywordtype">void</span>
<a name="l00500"></a>00500 <a class="code" href="classserial_1_1_serial.html#afa2c1f9114a37b7d140fc2292d1499b9">flushInput</a> ();
<a name="l00501"></a>00501
<a name="l00503"></a>00503 <span class="keywordtype">void</span>
<a name="l00504"></a>00504 <a class="code" href="classserial_1_1_serial.html#a256ee4bb93ab0e79d7a66b50f08dce53">flushOutput</a> ();
<a name="l00505"></a>00505
<a name="l00507"></a>00507 <span class="keywordtype">void</span>
<a name="l00508"></a>00508 <a class="code" href="classserial_1_1_serial.html#ade90ff8f03525ea6d7b702fcd0f336de">sendBreak</a> (<span class="keywordtype">int</span> duration);
<a name="l00509"></a>00509
<a name="l00511"></a>00511 <span class="keywordtype">void</span>
<a name="l00512"></a>00512 <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="l00513"></a>00513
<a name="l00515"></a>00515 <span class="keywordtype">void</span>
<a name="l00516"></a>00516 <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="l00517"></a>00517
<a name="l00519"></a>00519 <span class="keywordtype">void</span>
<a name="l00520"></a>00520 <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="l00521"></a>00521
<a name="l00533"></a>00533 <span class="keywordtype">bool</span>
<a name="l00534"></a>00534 <a class="code" href="classserial_1_1_serial.html#a419dc984258956a5adb41fb8c86f5449">waitForChange</a> ();
<a name="l00535"></a>00535
<a name="l00537"></a>00537 <span class="keywordtype">bool</span>
<a name="l00538"></a>00538 <a class="code" href="classserial_1_1_serial.html#a809f048546c4c72b74e205139b97648c">getCTS</a> ();
<a name="l00539"></a>00539
<a name="l00541"></a>00541 <span class="keywordtype">bool</span>
<a name="l00542"></a>00542 <a class="code" href="classserial_1_1_serial.html#a6b9a0c485e1fe599dbb5e9e15b1a65d6">getDSR</a> ();
<a name="l00543"></a>00543
<a name="l00545"></a>00545 <span class="keywordtype">bool</span>
<a name="l00546"></a>00546 <a class="code" href="classserial_1_1_serial.html#afb96e6968f040c4bff7576095f4ba6e7">getRI</a> ();
<a name="l00547"></a>00547
<a name="l00549"></a>00549 <span class="keywordtype">bool</span>
<a name="l00550"></a>00550 <a class="code" href="classserial_1_1_serial.html#a9795a3e83e6745a14c64f657e68061fb">getCD</a> ();
<a name="l00551"></a>00551
<a name="l00552"></a>00552 <span class="keyword">private</span>:
<a name="l00553"></a>00553 <span class="comment">// Disable copy constructors</span>
<a name="l00554"></a>00554 <a class="code" href="classserial_1_1_serial.html#a5c7bf8dcebe4dcf4269641fcd6d773e7">Serial</a>(<span class="keyword">const</span> <a class="code" href="classserial_1_1_serial.html">Serial</a>&amp;);
<a name="l00555"></a>00555 <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="l00556"></a>00556 <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="l00557"></a>00557
<a name="l00558"></a>00558 std::string read_cache_;
<a name="l00559"></a>00559
<a name="l00560"></a>00560 <span class="comment">// Pimpl idiom, d_pointer</span>
<a name="l00561"></a>00561 <span class="keyword">class </span>SerialImpl;
<a name="l00562"></a>00562 SerialImpl *pimpl_;
<a name="l00563"></a>00563
<a name="l00564"></a>00564 <span class="comment">// Scoped Lock Classes</span>
<a name="l00565"></a>00565 <span class="keyword">class </span>ScopedReadLock;
<a name="l00566"></a>00566 <span class="keyword">class </span>ScopedWriteLock;
<a name="l00567"></a>00567
<a name="l00568"></a>00568 <span class="comment">// Read common function</span>
<a name="l00569"></a>00569 <span class="keywordtype">size_t</span>
<a name="l00570"></a>00570 read_ (<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> size);
<a name="l00571"></a>00571
<a name="l00572"></a>00572 };
<a name="l00573"></a>00573
<a name="l00574"></a><a class="code" href="classserial_1_1_serial_execption.html">00574</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="l00575"></a>00575 {
<a name="l00576"></a>00576 <span class="keyword">const</span> <span class="keywordtype">char</span>* e_what_;
<a name="l00577"></a>00577 <span class="keyword">public</span>:
<a name="l00578"></a><a class="code" href="classserial_1_1_serial_execption.html#aa4b29d2631c6a9a0ebe591834bbc4609">00578</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="l00579"></a>00579
<a name="l00580"></a><a class="code" href="classserial_1_1_serial_execption.html#a5cb17e5438390e95731ddd230524922d">00580</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="l00581"></a>00581 {
<a name="l00582"></a>00582 std::stringstream ss;
<a name="l00583"></a>00583 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="l00584"></a>00584 <span class="keywordflow">return</span> ss.str ().c_str ();
<a name="l00585"></a>00585 }
<a name="l00586"></a>00586 };
<a name="l00587"></a>00587
<a name="l00588"></a><a class="code" href="classserial_1_1_i_o_exception.html">00588</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="l00589"></a>00589 {
<a name="l00590"></a>00590 std::string file_;
<a name="l00591"></a>00591 <span class="keywordtype">int</span> line_;
<a name="l00592"></a>00592 <span class="keyword">const</span> <span class="keywordtype">char</span>* e_what_;
<a name="l00593"></a>00593 <span class="keywordtype">int</span> errno_;
<a name="l00594"></a>00594 <span class="keyword">public</span>:
<a name="l00595"></a><a class="code" href="classserial_1_1_i_o_exception.html#acb2f2cf7a5cc8090945f6cbfcef3ef1e">00595</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="l00596"></a>00596 : file_(file), line_(line), e_what_ (strerror (errnum)), errno_(errnum) {}
<a name="l00597"></a><a class="code" href="classserial_1_1_i_o_exception.html#acc1d2c650832cc8127f2cd777072b2cd">00597</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="l00598"></a>00598 : file_(file), line_(line), e_what_ (description), errno_(0) {}
<a name="l00599"></a><a class="code" href="classserial_1_1_i_o_exception.html#a026ae2e6abc57c6069915f0f8c701390">00599</a> <span class="keyword">virtual</span> <a class="code" href="classserial_1_1_i_o_exception.html#a026ae2e6abc57c6069915f0f8c701390">~IOException</a>() throw() {}
<a name="l00600"></a>00600
<a name="l00601"></a><a class="code" href="classserial_1_1_i_o_exception.html#a91d5ee5241dd49fb39e8e762564b6cc5">00601</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="l00602"></a>00602
<a name="l00603"></a><a class="code" href="classserial_1_1_i_o_exception.html#a5151f78cf0309db2c79f3dc4c779c774">00603</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="l00604"></a>00604 {
<a name="l00605"></a>00605 std::stringstream ss;
<a name="l00606"></a>00606 <span class="keywordflow">if</span> (errno_ == 0)
<a name="l00607"></a>00607 ss &lt;&lt; <span class="stringliteral">&quot;IO Exception: &quot;</span> &lt;&lt; e_what_;
<a name="l00608"></a>00608 <span class="keywordflow">else</span>
<a name="l00609"></a>00609 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="l00610"></a>00610 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="l00611"></a>00611 <span class="keywordflow">return</span> ss.str ().c_str ();
<a name="l00612"></a>00612 }
<a name="l00613"></a>00613 };
<a name="l00614"></a>00614
<a name="l00615"></a><a class="code" href="classserial_1_1_port_not_opened_exception.html">00615</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="l00616"></a>00616 {
<a name="l00617"></a>00617 <span class="keyword">const</span> <span class="keywordtype">char</span> * e_what_;
<a name="l00618"></a>00618 <span class="keyword">public</span>:
<a name="l00619"></a><a class="code" href="classserial_1_1_port_not_opened_exception.html#acd2213fae864534eae6a580f74c5ab1b">00619</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="l00620"></a>00620
<a name="l00621"></a><a class="code" href="classserial_1_1_port_not_opened_exception.html#a314c997ecfe3990c4af147b247e8d9ce">00621</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="l00622"></a>00622 {
<a name="l00623"></a>00623 std::stringstream ss;
<a name="l00624"></a>00624 ss &lt;&lt; e_what_ &lt;&lt; <span class="stringliteral">&quot; called before port was opened.&quot;</span>;
<a name="l00625"></a>00625 <span class="keywordflow">return</span> ss.str ().c_str ();
<a name="l00626"></a>00626 }
<a name="l00627"></a>00627 };
<a name="l00628"></a>00628
<a name="l00629"></a><a class="code" href="classserial_1_1_serial_exception_base.html">00629</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="l00630"></a>00630 {
<a name="l00631"></a>00631
<a name="l00632"></a>00632 };
<a name="l00633"></a>00633
<a name="l00634"></a>00634 } <span class="comment">// namespace serial</span>
<a name="l00635"></a>00635
<a name="l00636"></a>00636 <span class="preprocessor">#endif</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 2 2012 00:34:19 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 Copy Permalink