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

Last change on this file since 94 was 94, checked in by Sanahuja Guillaume, 22 months ago

draw vrpn axis in simulator

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