Myth/serial
1
0
Fork 0
mirror of https://github.com/wjwwood/serial.git synced 2026-01-22 19:54:57 +08:00
Code Issues Projects Releases Wiki Activity
serial/docs/v0.2/functions.html

367 lines
19 KiB
HTML
Raw Normal View History

Updating pages and documentation
2012-06-09 19:35:49 -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: Data Fields</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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li class="current"><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
<div id="navrow3" class="tabs2">
<ul class="tablist">
<li class="current"><a href="functions.html"><span>All</span></a></li>
<li><a href="functions_func.html"><span>Functions</span></a></li>
</ul>
</div>
<div id="navrow4" class="tabs3">
<ul class="tablist">
<li><a href="#index_a"><span>a</span></a></li>
<li><a href="#index_c"><span>c</span></a></li>
<li><a href="#index_f"><span>f</span></a></li>
<li><a href="#index_g"><span>g</span></a></li>
<li><a href="#index_i"><span>i</span></a></li>
<li><a href="#index_o"><span>o</span></a></li>
<li><a href="#index_p"><span>p</span></a></li>
<li><a href="#index_r"><span>r</span></a></li>
<li><a href="#index_s"><span>s</span></a></li>
<li><a href="#index_w"><span>w</span></a></li>
<li><a href="#index_0x7e"><span>~</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="contents">
<div class="textblock">Here is a list of all struct and union fields with links to the structures/unions they belong to:</div>
<h3><a class="anchor" id="index_a"></a>- a -</h3><ul>
<li>available()
: <a class="el" href="classserial_1_1_serial.html#afafe25b2f3bb0809550abdc72c51a234">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aecd5e068c21b076bcf161f7bf7f415f5">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
<li>close()
: <a class="el" href="classserial_1_1_serial.html#afbe59407e718bc3d22ea4a67b304db6c">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a2608096ba0d17127b17484fc9481833a">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_f"></a>- f -</h3><ul>
<li>flush()
: <a class="el" href="classserial_1_1_serial.html#a63b7abf172cad25bfc998b3b1f98310f">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a7dc1818234ab3f5ae3ebd67bc79d8511">serial::serial::Serial::SerialImpl</a>
</li>
<li>flushInput()
: <a class="el" href="classserial_1_1_serial.html#afa2c1f9114a37b7d140fc2292d1499b9">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a28003745a26c0924fc1d305e947bc3bf">serial::serial::Serial::SerialImpl</a>
</li>
<li>flushOutput()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ac61932385ea2ce645192e1539349500b">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#a256ee4bb93ab0e79d7a66b50f08dce53">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a5b2c81540ca1e1eb962249ca8f538299">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_g"></a>- g -</h3><ul>
<li>getBaudrate()
: <a class="el" href="classserial_1_1_serial.html#acd0e5a25e4484d6f08fe02c1911ab5e0">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#af04d2d662a302d446bf8a99151e7a229">serial::serial::Serial::SerialImpl</a>
</li>
<li>getBytesize()
: <a class="el" href="classserial_1_1_serial.html#a4fce90ef7a9a46525efa373a94a1bfbd">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aafeff74e9aed67a996735dbb46323b25">serial::serial::Serial::SerialImpl</a>
</li>
<li>getCD()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a6f2a8d7ff955fc3f061b513c095859e1">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#a9795a3e83e6745a14c64f657e68061fb">serial::Serial</a>
</li>
<li>getCTS()
: <a class="el" href="classserial_1_1_serial.html#a809f048546c4c72b74e205139b97648c">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a0801d20b6e906369ad232e460b741d7b">serial::serial::Serial::SerialImpl</a>
</li>
<li>getDSR()
: <a class="el" href="classserial_1_1_serial.html#a6b9a0c485e1fe599dbb5e9e15b1a65d6">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a15d1d986dad6ec754919bb38c3470362">serial::serial::Serial::SerialImpl</a>
</li>
<li>getErrorNumber()
: <a class="el" href="classserial_1_1_i_o_exception.html#a91d5ee5241dd49fb39e8e762564b6cc5">serial::IOException</a>
</li>
<li>getFlowcontrol()
: <a class="el" href="classserial_1_1_serial.html#acdc6da48a5434b936b1db20f36caf41f">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#af1b3fe4ea4d075b76b0c243d4ed768ec">serial::serial::Serial::SerialImpl</a>
</li>
<li>getParity()
: <a class="el" href="classserial_1_1_serial.html#a89d876e1d3f0afadb0d6c21b08ed8931">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa7cc3b7bd62ad98d25f2e2e0f27d3b42">serial::serial::Serial::SerialImpl</a>
</li>
<li>getPort()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a1f881c2cf8bfc92a7836ee0dd554ec44">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#ae95cd057e90258b1b3203ff8972a3567">serial::Serial</a>
</li>
<li>getRI()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a0ee5f4cd897bc177a179ec4f0ba8c561">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#afb96e6968f040c4bff7576095f4ba6e7">serial::Serial</a>
</li>
<li>getStopbits()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#af52b7b4b1d78b9fc98f7150587ddc8b6">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#a42887bb76243bf6bbb3f69ff60f9792e">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#af52b7b4b1d78b9fc98f7150587ddc8b6">serial::serial::Serial::SerialImpl</a>
</li>
<li>getTimeout()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ae79177ed275c9cb5af7e5617644818f9">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#a345cd91d7bd366e990e295f756d51112">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ae79177ed275c9cb5af7e5617644818f9">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
<li>IOException()
: <a class="el" href="classserial_1_1_i_o_exception.html#acb2f2cf7a5cc8090945f6cbfcef3ef1e">serial::IOException</a>
</li>
<li>isOpen()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a189fe759d2119a6513d5981575a91b8e">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#af9895af496189f7f0aba7c097f5fa9c1">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a189fe759d2119a6513d5981575a91b8e">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_o"></a>- o -</h3><ul>
<li>open()
: <a class="el" href="classserial_1_1_serial.html#af3644ed1a9d899b70e9d63bb9b808d62">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a279801879f609e1845e3e730f5651aa2">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_p"></a>- p -</h3><ul>
<li>PortNotOpenedException()
: <a class="el" href="classserial_1_1_port_not_opened_exception.html#acd2213fae864534eae6a580f74c5ab1b">serial::PortNotOpenedException</a>
</li>
</ul>
<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
<li>read()
: <a class="el" href="classserial_1_1_serial.html#a2bcd2c76cdacf64928fcd7e9ec279ff1">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ab38e31999f75db98b45e74e9b8f66343">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#ac47576244e34abc2e460ba99684c351f">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a332155c4d26e565a73d9823bc7d1da91">serial::serial::Serial::SerialImpl</a>
</li>
<li>readline()
: <a class="el" href="classserial_1_1_serial.html#a04177f637cc02f92ec0492d377528b2a">serial::Serial</a>
</li>
<li>readlines()
: <a class="el" href="classserial_1_1_serial.html#a99f77b9bbdc128b6704cc59db77686c5">serial::Serial</a>
</li>
<li>readLock()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a284eeedc3dd686ecef0fdcfd83bebc54">serial::serial::Serial::SerialImpl</a>
</li>
<li>readUnlock()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ab6533e884ba609a1dd6a88b7964d8b52">serial::serial::Serial::SerialImpl</a>
</li>
<li>reconfigurePort()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ad006a2392150daddfa43ae288259c07d">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
<li>ScopedReadLock()
: <a class="el" href="class_serial_1_1_scoped_read_lock.html#a54f59663807d8adfe6db712ee6103503">serial::Serial::ScopedReadLock</a>
</li>
<li>ScopedWriteLock()
: <a class="el" href="class_serial_1_1_scoped_write_lock.html#a662173968431aee3d6f204c354b20225">serial::Serial::ScopedWriteLock</a>
</li>
<li>sendBreak()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a3f738264b8236e271d79835f0ec08bf3">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#ade90ff8f03525ea6d7b702fcd0f336de">serial::Serial</a>
</li>
<li>Serial()
: <a class="el" href="classserial_1_1_serial.html#a9222791dd26285a594cfc594f0879b10">serial::Serial</a>
</li>
<li>SerialExecption()
: <a class="el" href="classserial_1_1_serial_execption.html#aa4b29d2631c6a9a0ebe591834bbc4609">serial::SerialExecption</a>
</li>
<li>SerialImpl()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a2fa9977e6f06797623d3f4ea36c09d02">serial::serial::Serial::SerialImpl</a>
</li>
<li>setBaudrate()
: <a class="el" href="classserial_1_1_serial.html#aec535895c800e3fd7c52d60b9f6b08a5">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a9773deb112bc756a7512930ec4bf23b3">serial::serial::Serial::SerialImpl</a>
</li>
<li>setBreak()
: <a class="el" href="classserial_1_1_serial.html#a2a27912b1ca5cdad4a4aba7b9ddbc206">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aff11802f071e95c0e88ef6d0fa3bacd7">serial::serial::Serial::SerialImpl</a>
</li>
<li>setBytesize()
: <a class="el" href="classserial_1_1_serial.html#adba430fd704f6898a5a1d99fd39a94fa">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ac7bde1547ae13c2bbb09126ae7082661">serial::serial::Serial::SerialImpl</a>
</li>
<li>setDTR()
: <a class="el" href="classserial_1_1_serial.html#ac9b0bbf613a5fe68f05d1d40181a1bb3">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a741dbda555f51bb7be361a602f72358c">serial::serial::Serial::SerialImpl</a>
</li>
<li>setFlowcontrol()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a70f3aaa863c4d11c226a983377a37e43">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#ade41650d6bfe91b6432e5a0a60c03969">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a70f3aaa863c4d11c226a983377a37e43">serial::serial::Serial::SerialImpl</a>
</li>
<li>setParity()
: <a class="el" href="classserial_1_1_serial.html#a1e1896aa59ec35ac5bd263b87614ef01">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a2619123d52d075967bdb35247f40e51b">serial::serial::Serial::SerialImpl</a>
</li>
<li>setPort()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa3b4c490f3246a506dd29135553ecd64">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#acecb0a5102ae0c944fe4b78e4adf839a">serial::Serial</a>
</li>
<li>setRTS()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa6f543e9fb4517fa00835eee15fa5ffa">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#ab43ddc05e5d69ff2778f698aa7062370">serial::Serial</a>
</li>
<li>setStopbits()
: <a class="el" href="classserial_1_1_serial.html#ab72284b5aab723b81013fb560bd6acc5">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a697da32867459d1c4e527c3ec468062e">serial::serial::Serial::SerialImpl</a>
</li>
<li>setTimeout()
: <a class="el" href="classserial_1_1_serial.html#ab6ad13f872e31b9cf0af8cbeb9117cb0">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa1eb04036c3ed8ad67e243164760bba6">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_w"></a>- w -</h3><ul>
<li>what()
: <a class="el" href="classserial_1_1_serial_execption.html#a5cb17e5438390e95731ddd230524922d">serial::SerialExecption</a>
, <a class="el" href="classserial_1_1_i_o_exception.html#a5151f78cf0309db2c79f3dc4c779c774">serial::IOException</a>
, <a class="el" href="classserial_1_1_port_not_opened_exception.html#a314c997ecfe3990c4af147b247e8d9ce">serial::PortNotOpenedException</a>
</li>
<li>write()
: <a class="el" href="classserial_1_1_serial.html#acd98ae129db624b664a5dd51f352d8f7">serial::Serial</a>
, <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa248734f59cb31a2ca5d1bcb50e53e3e">serial::serial::Serial::SerialImpl</a>
, <a class="el" href="classserial_1_1_serial.html#a280abb1b73ac368591d79badf23776bf">serial::Serial</a>
</li>
<li>writeLock()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a2905e50e9082a757bfafc03356e318ed">serial::serial::Serial::SerialImpl</a>
</li>
<li>writeUnlock()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#adaec2b322f0b0793929da24f5bf09949">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
<h3><a class="anchor" id="index_0x7e"></a>- ~ -</h3><ul>
<li>~IOException()
: <a class="el" href="classserial_1_1_i_o_exception.html#a026ae2e6abc57c6069915f0f8c701390">serial::IOException</a>
</li>
<li>~ScopedReadLock()
: <a class="el" href="class_serial_1_1_scoped_read_lock.html#a5c061909b95231cec776c40094c878b4">serial::Serial::ScopedReadLock</a>
</li>
<li>~ScopedWriteLock()
: <a class="el" href="class_serial_1_1_scoped_write_lock.html#aebeef5b2d16f409b60094cfac092ada2">serial::Serial::ScopedWriteLock</a>
</li>
<li>~Serial()
: <a class="el" href="classserial_1_1_serial.html#a5b32c394c0ff923a4ef1c13cfb20a6ba">serial::Serial</a>
</li>
<li>~SerialImpl()
: <a class="el" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a7972685753e76e0068b754601442a8a5">serial::serial::Serial::SerialImpl</a>
</li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jun 9 2012 18:39:49 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