source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_serial_port.html @ 15

Last change on this file since 15 was 15, checked in by Sanahuja Guillaume, 5 years ago

m

File size: 30.5 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
7<title>Flair: flair::core::SerialPort Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtree.js"></script>
14<script type="text/javascript">
15  $(document).ready(initResizable);
16  $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21  $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32  <td style="padding-left: 0.5em;">
33   <div id="projectname">Flair
34   </div>
35   <div id="projectbrief">Framework Libre Air</div>
36  </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46  <div id="navrow1" class="tabs">
47    <ul class="tablist">
48      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
51      <li><a href="files.html"><span>Files</span></a></li>
52      <li>
53        <div id="MSearchBox" class="MSearchBoxInactive">
54        <span class="left">
55          <img id="MSearchSelect" src="search/mag_sel.png"
56               onmouseover="return searchBox.OnSearchSelectShow()"
57               onmouseout="return searchBox.OnSearchSelectHide()"
58               alt=""/>
59          <input type="text" id="MSearchField" value="Search" accesskey="S"
60               onfocus="searchBox.OnSearchFieldFocus(true)" 
61               onblur="searchBox.OnSearchFieldFocus(false)" 
62               onkeyup="searchBox.OnSearchFieldChange(event)"/>
63          </span><span class="right">
64            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65          </span>
66        </div>
67      </li>
68    </ul>
69  </div>
70  <div id="navrow2" class="tabs2">
71    <ul class="tablist">
72      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
73      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
74      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
75      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
76    </ul>
77  </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80  <div id="nav-tree">
81    <div id="nav-tree-contents">
82      <div id="nav-sync" class="sync"></div>
83    </div>
84  </div>
85  <div id="splitbar" style="-moz-user-select:none;" 
86       class="ui-resizable-handle">
87  </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('classflair_1_1core_1_1_serial_port.html','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95     onmouseover="return searchBox.OnSearchSelectShow()"
96     onmouseout="return searchBox.OnSearchSelectHide()"
97     onkeydown="return searchBox.OnSearchSelectKey(event)">
98<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>Classes</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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0" 
103        name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108  <div class="summary">
109<a href="#pub-methods">Public Member Functions</a> &#124;
110<a href="classflair_1_1core_1_1_serial_port-members.html">List of all members</a>  </div>
111  <div class="headertitle">
112<div class="title">flair::core::SerialPort Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Base class for serial port. 
117 <a href="classflair_1_1core_1_1_serial_port.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_serial_port_8h_source.html">SerialPort.h</a>&gt;</code></p>
120<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
121  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::core::SerialPort:</div>
122<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
123</div>
124<div id="dynsection-0-content" class="dyncontent" style="display:none;">
125 <div class="center">
126  <img src="classflair_1_1core_1_1_serial_port.png" usemap="#flair::core::SerialPort_map" alt=""/>
127  <map id="flair::core::SerialPort_map" name="flair::core::SerialPort_map">
128<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="90,0,260,24"/>
129<area href="classflair_1_1core_1_1_r_t_d_m___serial_port.html" title="Class for real time serial port using RTDM. " alt="flair::core::RTDM_SerialPort" shape="rect" coords="0,112,170,136"/>
130<area href="classflair_1_1core_1_1_unix___serial_port.html" alt="flair::core::Unix_SerialPort" shape="rect" coords="180,112,350,136"/>
131</map>
132 </div></div>
133<table class="memberdecls">
134<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
135Public Member Functions</h2></td></tr>
136<tr class="memitem:aa6f8c5f8c8a9e435635b1730feebc90c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_serial_port.html#aa6f8c5f8c8a9e435635b1730feebc90c">SerialPort</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name)</td></tr>
137<tr class="memdesc:aa6f8c5f8c8a9e435635b1730feebc90c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aa6f8c5f8c8a9e435635b1730feebc90c">More...</a><br /></td></tr>
138<tr class="separator:aa6f8c5f8c8a9e435635b1730feebc90c"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:aeb4eab5de344483667176a101607bb68"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_serial_port.html#aeb4eab5de344483667176a101607bb68">~SerialPort</a> ()</td></tr>
140<tr class="memdesc:aeb4eab5de344483667176a101607bb68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aeb4eab5de344483667176a101607bb68">More...</a><br /></td></tr>
141<tr class="separator:aeb4eab5de344483667176a101607bb68"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:ad9f27342a1d501d7cd64eb3a215572fe"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_serial_port.html#ad9f27342a1d501d7cd64eb3a215572fe">SetBaudrate</a> (int baudrate)=0</td></tr>
143<tr class="memdesc:ad9f27342a1d501d7cd64eb3a215572fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set baudrate.  <a href="#ad9f27342a1d501d7cd64eb3a215572fe">More...</a><br /></td></tr>
144<tr class="separator:ad9f27342a1d501d7cd64eb3a215572fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:a54b5711f111f84656201dcd2ac2c03cf"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_serial_port.html#a54b5711f111f84656201dcd2ac2c03cf">SetRxTimeout</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns)=0</td></tr>
146<tr class="memdesc:a54b5711f111f84656201dcd2ac2c03cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set RX timeout.  <a href="#a54b5711f111f84656201dcd2ac2c03cf">More...</a><br /></td></tr>
147<tr class="separator:a54b5711f111f84656201dcd2ac2c03cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<tr class="memitem:ac67f66b90f567de20b77afc287504740"><td class="memItemLeft" align="right" valign="top">virtual ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_serial_port.html#ac67f66b90f567de20b77afc287504740">Write</a> (const void *buf, size_t nbyte)=0</td></tr>
149<tr class="memdesc:ac67f66b90f567de20b77afc287504740"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write datas.  <a href="#ac67f66b90f567de20b77afc287504740">More...</a><br /></td></tr>
150<tr class="separator:ac67f66b90f567de20b77afc287504740"><td class="memSeparator" colspan="2">&#160;</td></tr>
151<tr class="memitem:a5e9f8971fc5ea70a2d66a771c6e7d711"><td class="memItemLeft" align="right" valign="top">virtual ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_serial_port.html#a5e9f8971fc5ea70a2d66a771c6e7d711">Read</a> (void *buf, size_t nbyte)=0</td></tr>
152<tr class="memdesc:a5e9f8971fc5ea70a2d66a771c6e7d711"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read datas.  <a href="#a5e9f8971fc5ea70a2d66a771c6e7d711">More...</a><br /></td></tr>
153<tr class="separator:a5e9f8971fc5ea70a2d66a771c6e7d711"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<tr class="memitem:aff9d6e015290651328785e94b133445d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_serial_port.html#aff9d6e015290651328785e94b133445d">FlushInput</a> (void)=0</td></tr>
155<tr class="memdesc:aff9d6e015290651328785e94b133445d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush input datas.  <a href="#aff9d6e015290651328785e94b133445d">More...</a><br /></td></tr>
156<tr class="separator:aff9d6e015290651328785e94b133445d"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
158<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
159<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
160<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
162<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
163<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
165<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name.  <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
166<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
168<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type.  <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
169<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
171<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent.  <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
172<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
174<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type.  <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
175<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
177<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs.  <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
178<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
180<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information.  <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
181<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
183<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning.  <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
184<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
186<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error.  <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
187<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
189<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
190<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
191</table><table class="memberdecls">
192<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
193Additional Inherited Members</h2></td></tr>
194<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
195<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
196<b>Red</b> = 31,
197<b>Green</b> = 32,
198<b>Orange</b> = 33
199 }</td></tr>
200<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
201</table>
202<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
203<div class="textblock"><p>Base class for serial port. </p>
204</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
205<a class="anchor" id="aa6f8c5f8c8a9e435635b1730feebc90c"></a>
206<div class="memitem">
207<div class="memproto">
208<table class="mlabels">
209  <tr>
210  <td class="mlabels-left">
211      <table class="memname">
212        <tr>
213          <td class="memname">flair::core::SerialPort::SerialPort </td>
214          <td>(</td>
215          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
216          <td class="paramname"><em>parent</em>, </td>
217        </tr>
218        <tr>
219          <td class="paramkey"></td>
220          <td></td>
221          <td class="paramtype">std::string&#160;</td>
222          <td class="paramname"><em>name</em>&#160;</td>
223        </tr>
224        <tr>
225          <td></td>
226          <td>)</td>
227          <td></td><td></td>
228        </tr>
229      </table>
230  </td>
231  <td class="mlabels-right">
232<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
233  </tr>
234</table>
235</div><div class="memdoc">
236
237<p>Constructor. </p>
238<p>Construct a serial port.</p>
239<dl class="params"><dt>Parameters</dt><dd>
240  <table class="params">
241    <tr><td class="paramname">parent</td><td>parent </td></tr>
242    <tr><td class="paramname">name</td><td>name </td></tr>
243  </table>
244  </dd>
245</dl>
246
247</div>
248</div>
249<a class="anchor" id="aeb4eab5de344483667176a101607bb68"></a>
250<div class="memitem">
251<div class="memproto">
252<table class="mlabels">
253  <tr>
254  <td class="mlabels-left">
255      <table class="memname">
256        <tr>
257          <td class="memname">flair::core::SerialPort::~SerialPort </td>
258          <td>(</td>
259          <td class="paramname"></td><td>)</td>
260          <td></td>
261        </tr>
262      </table>
263  </td>
264  <td class="mlabels-right">
265<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
266  </tr>
267</table>
268</div><div class="memdoc">
269
270<p>Destructor. </p>
271
272</div>
273</div>
274<h2 class="groupheader">Member Function Documentation</h2>
275<a class="anchor" id="ad9f27342a1d501d7cd64eb3a215572fe"></a>
276<div class="memitem">
277<div class="memproto">
278<table class="mlabels">
279  <tr>
280  <td class="mlabels-left">
281      <table class="memname">
282        <tr>
283          <td class="memname">virtual void flair::core::SerialPort::SetBaudrate </td>
284          <td>(</td>
285          <td class="paramtype">int&#160;</td>
286          <td class="paramname"><em>baudrate</em></td><td>)</td>
287          <td></td>
288        </tr>
289      </table>
290  </td>
291  <td class="mlabels-right">
292<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
293  </tr>
294</table>
295</div><div class="memdoc">
296
297<p>Set baudrate. </p>
298<dl class="params"><dt>Parameters</dt><dd>
299  <table class="params">
300    <tr><td class="paramname">baudrate</td><td>baudrate </td></tr>
301  </table>
302  </dd>
303</dl>
304
305<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#ad0e57407f0a2cad1b20ac7339d3b554a">flair::core::RTDM_SerialPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___serial_port.html#ad62c002d6eedf55541c2290ec48b0e75">flair::core::Unix_SerialPort</a>.</p>
306
307</div>
308</div>
309<a class="anchor" id="a54b5711f111f84656201dcd2ac2c03cf"></a>
310<div class="memitem">
311<div class="memproto">
312<table class="mlabels">
313  <tr>
314  <td class="mlabels-left">
315      <table class="memname">
316        <tr>
317          <td class="memname">virtual void flair::core::SerialPort::SetRxTimeout </td>
318          <td>(</td>
319          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
320          <td class="paramname"><em>timeout_ns</em></td><td>)</td>
321          <td></td>
322        </tr>
323      </table>
324  </td>
325  <td class="mlabels-right">
326<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
327  </tr>
328</table>
329</div><div class="memdoc">
330
331<p>Set RX timeout. </p>
332<p>Timeout for waiting datas.</p>
333<dl class="params"><dt>Parameters</dt><dd>
334  <table class="params">
335    <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
336  </table>
337  </dd>
338</dl>
339
340<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#ad86eb870ed2544e957f8e6c31d35aa5d">flair::core::RTDM_SerialPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___serial_port.html#a006b93a07dd0e81eb8cdfd07b6439cd9">flair::core::Unix_SerialPort</a>.</p>
341
342</div>
343</div>
344<a class="anchor" id="ac67f66b90f567de20b77afc287504740"></a>
345<div class="memitem">
346<div class="memproto">
347<table class="mlabels">
348  <tr>
349  <td class="mlabels-left">
350      <table class="memname">
351        <tr>
352          <td class="memname">virtual ssize_t flair::core::SerialPort::Write </td>
353          <td>(</td>
354          <td class="paramtype">const void *&#160;</td>
355          <td class="paramname"><em>buf</em>, </td>
356        </tr>
357        <tr>
358          <td class="paramkey"></td>
359          <td></td>
360          <td class="paramtype">size_t&#160;</td>
361          <td class="paramname"><em>nbyte</em>&#160;</td>
362        </tr>
363        <tr>
364          <td></td>
365          <td>)</td>
366          <td></td><td></td>
367        </tr>
368      </table>
369  </td>
370  <td class="mlabels-right">
371<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
372  </tr>
373</table>
374</div><div class="memdoc">
375
376<p>Write datas. </p>
377<dl class="params"><dt>Parameters</dt><dd>
378  <table class="params">
379    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
380    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
381  </table>
382  </dd>
383</dl>
384<dl class="section return"><dt>Returns</dt><dd>amount of written datas </dd></dl>
385
386<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#a8a24c53a26ec9492ef7f68b5f297b15c">flair::core::RTDM_SerialPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___serial_port.html#a38880de840bde249a00f7b1837e77479">flair::core::Unix_SerialPort</a>.</p>
387
388</div>
389</div>
390<a class="anchor" id="a5e9f8971fc5ea70a2d66a771c6e7d711"></a>
391<div class="memitem">
392<div class="memproto">
393<table class="mlabels">
394  <tr>
395  <td class="mlabels-left">
396      <table class="memname">
397        <tr>
398          <td class="memname">virtual ssize_t flair::core::SerialPort::Read </td>
399          <td>(</td>
400          <td class="paramtype">void *&#160;</td>
401          <td class="paramname"><em>buf</em>, </td>
402        </tr>
403        <tr>
404          <td class="paramkey"></td>
405          <td></td>
406          <td class="paramtype">size_t&#160;</td>
407          <td class="paramname"><em>nbyte</em>&#160;</td>
408        </tr>
409        <tr>
410          <td></td>
411          <td>)</td>
412          <td></td><td></td>
413        </tr>
414      </table>
415  </td>
416  <td class="mlabels-right">
417<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
418  </tr>
419</table>
420</div><div class="memdoc">
421
422<p>Read datas. </p>
423<dl class="params"><dt>Parameters</dt><dd>
424  <table class="params">
425    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
426    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
427  </table>
428  </dd>
429</dl>
430<dl class="section return"><dt>Returns</dt><dd>amount of read datas </dd></dl>
431
432<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#abb4f3486983680b83430ed6af52e156b">flair::core::RTDM_SerialPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___serial_port.html#a728b2c89f129e7fbf5ce365f58f777b3">flair::core::Unix_SerialPort</a>.</p>
433
434</div>
435</div>
436<a class="anchor" id="aff9d6e015290651328785e94b133445d"></a>
437<div class="memitem">
438<div class="memproto">
439<table class="mlabels">
440  <tr>
441  <td class="mlabels-left">
442      <table class="memname">
443        <tr>
444          <td class="memname">virtual void flair::core::SerialPort::FlushInput </td>
445          <td>(</td>
446          <td class="paramtype">void&#160;</td>
447          <td class="paramname"></td><td>)</td>
448          <td></td>
449        </tr>
450      </table>
451  </td>
452  <td class="mlabels-right">
453<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
454  </tr>
455</table>
456</div><div class="memdoc">
457
458<p>Flush input datas. </p>
459
460<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#aecb9d6d453e2ded90598d9332d03d7e8">flair::core::RTDM_SerialPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___serial_port.html#a59cc8e9f58acc35325d29b43a473a823">flair::core::Unix_SerialPort</a>.</p>
461
462</div>
463</div>
464</div><!-- contents -->
465</div><!-- doc-content -->
466<!-- start footer part -->
467<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
468  <ul>
469    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1_serial_port.html">SerialPort</a></li>
470    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
471    <a href="http://www.doxygen.org/index.html">
472    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
473  </ul>
474</div>
475</body>
476</html>
Note: See TracBrowser for help on using the repository browser.