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

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

m

File size: 31.7 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::RTDM_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_r_t_d_m___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_r_t_d_m___serial_port-members.html">List of all members</a>  </div>
111  <div class="headertitle">
112<div class="title">flair::core::RTDM_SerialPort Class Reference</div>  </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Class for real time serial port using RTDM. 
117 <a href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_r_t_d_m___serial_port_8h_source.html">RTDM_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::RTDM_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_r_t_d_m___serial_port.png" usemap="#flair::core::RTDM_SerialPort_map" alt=""/>
127  <map id="flair::core::RTDM_SerialPort_map" name="flair::core::RTDM_SerialPort_map">
128<area href="classflair_1_1core_1_1_serial_port.html" title="Base class for serial port. " alt="flair::core::SerialPort" shape="rect" coords="0,56,170,80"/>
129<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="0,0,170,24"/>
130</map>
131 </div></div>
132<table class="memberdecls">
133<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
134Public Member Functions</h2></td></tr>
135<tr class="memitem:a93fe0bd5ea18afcc5d57b7be1f053bad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#a93fe0bd5ea18afcc5d57b7be1f053bad">RTDM_SerialPort</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string port_name, std::string device)</td></tr>
136<tr class="memdesc:a93fe0bd5ea18afcc5d57b7be1f053bad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a93fe0bd5ea18afcc5d57b7be1f053bad">More...</a><br /></td></tr>
137<tr class="separator:a93fe0bd5ea18afcc5d57b7be1f053bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
138<tr class="memitem:a5f2f993bc612dd68b5f19cd41a9135cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#a5f2f993bc612dd68b5f19cd41a9135cc">~RTDM_SerialPort</a> ()</td></tr>
139<tr class="memdesc:a5f2f993bc612dd68b5f19cd41a9135cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a5f2f993bc612dd68b5f19cd41a9135cc">More...</a><br /></td></tr>
140<tr class="separator:a5f2f993bc612dd68b5f19cd41a9135cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:ad0e57407f0a2cad1b20ac7339d3b554a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#ad0e57407f0a2cad1b20ac7339d3b554a">SetBaudrate</a> (int baudrate)</td></tr>
142<tr class="memdesc:ad0e57407f0a2cad1b20ac7339d3b554a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set baudrate.  <a href="#ad0e57407f0a2cad1b20ac7339d3b554a">More...</a><br /></td></tr>
143<tr class="separator:ad0e57407f0a2cad1b20ac7339d3b554a"><td class="memSeparator" colspan="2">&#160;</td></tr>
144<tr class="memitem:ad86eb870ed2544e957f8e6c31d35aa5d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#ad86eb870ed2544e957f8e6c31d35aa5d">SetRxTimeout</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns)</td></tr>
145<tr class="memdesc:ad86eb870ed2544e957f8e6c31d35aa5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set RX timeout.  <a href="#ad86eb870ed2544e957f8e6c31d35aa5d">More...</a><br /></td></tr>
146<tr class="separator:ad86eb870ed2544e957f8e6c31d35aa5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
147<tr class="memitem:a8a24c53a26ec9492ef7f68b5f297b15c"><td class="memItemLeft" align="right" valign="top">ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#a8a24c53a26ec9492ef7f68b5f297b15c">Write</a> (const void *buf, size_t nbyte)</td></tr>
148<tr class="memdesc:a8a24c53a26ec9492ef7f68b5f297b15c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write datas.  <a href="#a8a24c53a26ec9492ef7f68b5f297b15c">More...</a><br /></td></tr>
149<tr class="separator:a8a24c53a26ec9492ef7f68b5f297b15c"><td class="memSeparator" colspan="2">&#160;</td></tr>
150<tr class="memitem:abb4f3486983680b83430ed6af52e156b"><td class="memItemLeft" align="right" valign="top">ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#abb4f3486983680b83430ed6af52e156b">Read</a> (void *buf, size_t nbyte)</td></tr>
151<tr class="memdesc:abb4f3486983680b83430ed6af52e156b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read datas.  <a href="#abb4f3486983680b83430ed6af52e156b">More...</a><br /></td></tr>
152<tr class="separator:abb4f3486983680b83430ed6af52e156b"><td class="memSeparator" colspan="2">&#160;</td></tr>
153<tr class="memitem:aecb9d6d453e2ded90598d9332d03d7e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_r_t_d_m___serial_port.html#aecb9d6d453e2ded90598d9332d03d7e8">FlushInput</a> (void)</td></tr>
154<tr class="memdesc:aecb9d6d453e2ded90598d9332d03d7e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush input datas.  <a href="#aecb9d6d453e2ded90598d9332d03d7e8">More...</a><br /></td></tr>
155<tr class="separator:aecb9d6d453e2ded90598d9332d03d7e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
156<tr class="inherit_header pub_methods_classflair_1_1core_1_1_serial_port"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_serial_port')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_serial_port.html">flair::core::SerialPort</a></td></tr>
157<tr class="memitem:aa6f8c5f8c8a9e435635b1730feebc90c inherit pub_methods_classflair_1_1core_1_1_serial_port"><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>
158<tr class="memdesc:aa6f8c5f8c8a9e435635b1730feebc90c inherit pub_methods_classflair_1_1core_1_1_serial_port"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aa6f8c5f8c8a9e435635b1730feebc90c">More...</a><br /></td></tr>
159<tr class="separator:aa6f8c5f8c8a9e435635b1730feebc90c inherit pub_methods_classflair_1_1core_1_1_serial_port"><td class="memSeparator" colspan="2">&#160;</td></tr>
160<tr class="memitem:aeb4eab5de344483667176a101607bb68 inherit pub_methods_classflair_1_1core_1_1_serial_port"><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>
161<tr class="memdesc:aeb4eab5de344483667176a101607bb68 inherit pub_methods_classflair_1_1core_1_1_serial_port"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aeb4eab5de344483667176a101607bb68">More...</a><br /></td></tr>
162<tr class="separator:aeb4eab5de344483667176a101607bb68 inherit pub_methods_classflair_1_1core_1_1_serial_port"><td class="memSeparator" colspan="2">&#160;</td></tr>
163<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>
164<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>
165<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>
166<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<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>
168<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>
169<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<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>
171<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>
172<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<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>
174<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>
175<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<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>
177<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>
178<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<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>
180<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>
181<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<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>
183<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>
184<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<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>
186<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>
187<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<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>
189<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>
190<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
191<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>
192<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>
193<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
194<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>
195<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>
196<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
197</table><table class="memberdecls">
198<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
199Additional Inherited Members</h2></td></tr>
200<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>
201<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,
202<b>Red</b> = 31,
203<b>Green</b> = 32,
204<b>Orange</b> = 33
205 }</td></tr>
206<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
207</table>
208<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
209<div class="textblock"><p>Class for real time serial port using RTDM. </p>
210<p>This class can only be used with the real time version of Framework library. </p>
211</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
212<a class="anchor" id="a93fe0bd5ea18afcc5d57b7be1f053bad"></a>
213<div class="memitem">
214<div class="memproto">
215      <table class="memname">
216        <tr>
217          <td class="memname">flair::core::RTDM_SerialPort::RTDM_SerialPort </td>
218          <td>(</td>
219          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
220          <td class="paramname"><em>parent</em>, </td>
221        </tr>
222        <tr>
223          <td class="paramkey"></td>
224          <td></td>
225          <td class="paramtype">std::string&#160;</td>
226          <td class="paramname"><em>port_name</em>, </td>
227        </tr>
228        <tr>
229          <td class="paramkey"></td>
230          <td></td>
231          <td class="paramtype">std::string&#160;</td>
232          <td class="paramname"><em>device</em>&#160;</td>
233        </tr>
234        <tr>
235          <td></td>
236          <td>)</td>
237          <td></td><td></td>
238        </tr>
239      </table>
240</div><div class="memdoc">
241
242<p>Constructor. </p>
243<p>Construct an RTDM serial port, with the following default values: <br />
244</p><ul>
245<li>115200bps baudrate</li>
246</ul>
247<dl class="params"><dt>Parameters</dt><dd>
248  <table class="params">
249    <tr><td class="paramname">parent</td><td>parent </td></tr>
250    <tr><td class="paramname">name</td><td>name </td></tr>
251    <tr><td class="paramname">device</td><td>serial device (ex rtser1) </td></tr>
252  </table>
253  </dd>
254</dl>
255
256</div>
257</div>
258<a class="anchor" id="a5f2f993bc612dd68b5f19cd41a9135cc"></a>
259<div class="memitem">
260<div class="memproto">
261      <table class="memname">
262        <tr>
263          <td class="memname">flair::core::RTDM_SerialPort::~RTDM_SerialPort </td>
264          <td>(</td>
265          <td class="paramname"></td><td>)</td>
266          <td></td>
267        </tr>
268      </table>
269</div><div class="memdoc">
270
271<p>Destructor. </p>
272
273</div>
274</div>
275<h2 class="groupheader">Member Function Documentation</h2>
276<a class="anchor" id="ad0e57407f0a2cad1b20ac7339d3b554a"></a>
277<div class="memitem">
278<div class="memproto">
279<table class="mlabels">
280  <tr>
281  <td class="mlabels-left">
282      <table class="memname">
283        <tr>
284          <td class="memname">void flair::core::RTDM_SerialPort::SetBaudrate </td>
285          <td>(</td>
286          <td class="paramtype">int&#160;</td>
287          <td class="paramname"><em>baudrate</em></td><td>)</td>
288          <td></td>
289        </tr>
290      </table>
291  </td>
292  <td class="mlabels-right">
293<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
294  </tr>
295</table>
296</div><div class="memdoc">
297
298<p>Set baudrate. </p>
299<dl class="params"><dt>Parameters</dt><dd>
300  <table class="params">
301    <tr><td class="paramname">baudrate</td><td>baudrate </td></tr>
302  </table>
303  </dd>
304</dl>
305
306<p>Implements <a class="el" href="classflair_1_1core_1_1_serial_port.html#ad9f27342a1d501d7cd64eb3a215572fe">flair::core::SerialPort</a>.</p>
307
308</div>
309</div>
310<a class="anchor" id="ad86eb870ed2544e957f8e6c31d35aa5d"></a>
311<div class="memitem">
312<div class="memproto">
313<table class="mlabels">
314  <tr>
315  <td class="mlabels-left">
316      <table class="memname">
317        <tr>
318          <td class="memname">void flair::core::RTDM_SerialPort::SetRxTimeout </td>
319          <td>(</td>
320          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
321          <td class="paramname"><em>timeout_ns</em></td><td>)</td>
322          <td></td>
323        </tr>
324      </table>
325  </td>
326  <td class="mlabels-right">
327<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
328  </tr>
329</table>
330</div><div class="memdoc">
331
332<p>Set RX timeout. </p>
333<p>Timeout for waiting datas.</p>
334<dl class="params"><dt>Parameters</dt><dd>
335  <table class="params">
336    <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
337  </table>
338  </dd>
339</dl>
340
341<p>Implements <a class="el" href="classflair_1_1core_1_1_serial_port.html#a54b5711f111f84656201dcd2ac2c03cf">flair::core::SerialPort</a>.</p>
342
343</div>
344</div>
345<a class="anchor" id="a8a24c53a26ec9492ef7f68b5f297b15c"></a>
346<div class="memitem">
347<div class="memproto">
348<table class="mlabels">
349  <tr>
350  <td class="mlabels-left">
351      <table class="memname">
352        <tr>
353          <td class="memname">ssize_t flair::core::RTDM_SerialPort::Write </td>
354          <td>(</td>
355          <td class="paramtype">const void *&#160;</td>
356          <td class="paramname"><em>buf</em>, </td>
357        </tr>
358        <tr>
359          <td class="paramkey"></td>
360          <td></td>
361          <td class="paramtype">size_t&#160;</td>
362          <td class="paramname"><em>nbyte</em>&#160;</td>
363        </tr>
364        <tr>
365          <td></td>
366          <td>)</td>
367          <td></td><td></td>
368        </tr>
369      </table>
370  </td>
371  <td class="mlabels-right">
372<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
373  </tr>
374</table>
375</div><div class="memdoc">
376
377<p>Write datas. </p>
378<dl class="params"><dt>Parameters</dt><dd>
379  <table class="params">
380    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
381    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
382  </table>
383  </dd>
384</dl>
385<dl class="section return"><dt>Returns</dt><dd>amount of written datas </dd></dl>
386
387<p>Implements <a class="el" href="classflair_1_1core_1_1_serial_port.html#ac67f66b90f567de20b77afc287504740">flair::core::SerialPort</a>.</p>
388
389</div>
390</div>
391<a class="anchor" id="abb4f3486983680b83430ed6af52e156b"></a>
392<div class="memitem">
393<div class="memproto">
394<table class="mlabels">
395  <tr>
396  <td class="mlabels-left">
397      <table class="memname">
398        <tr>
399          <td class="memname">ssize_t flair::core::RTDM_SerialPort::Read </td>
400          <td>(</td>
401          <td class="paramtype">void *&#160;</td>
402          <td class="paramname"><em>buf</em>, </td>
403        </tr>
404        <tr>
405          <td class="paramkey"></td>
406          <td></td>
407          <td class="paramtype">size_t&#160;</td>
408          <td class="paramname"><em>nbyte</em>&#160;</td>
409        </tr>
410        <tr>
411          <td></td>
412          <td>)</td>
413          <td></td><td></td>
414        </tr>
415      </table>
416  </td>
417  <td class="mlabels-right">
418<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
419  </tr>
420</table>
421</div><div class="memdoc">
422
423<p>Read datas. </p>
424<dl class="params"><dt>Parameters</dt><dd>
425  <table class="params">
426    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
427    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
428  </table>
429  </dd>
430</dl>
431<dl class="section return"><dt>Returns</dt><dd>amount of read datas </dd></dl>
432
433<p>Implements <a class="el" href="classflair_1_1core_1_1_serial_port.html#a5e9f8971fc5ea70a2d66a771c6e7d711">flair::core::SerialPort</a>.</p>
434
435</div>
436</div>
437<a class="anchor" id="aecb9d6d453e2ded90598d9332d03d7e8"></a>
438<div class="memitem">
439<div class="memproto">
440<table class="mlabels">
441  <tr>
442  <td class="mlabels-left">
443      <table class="memname">
444        <tr>
445          <td class="memname">void flair::core::RTDM_SerialPort::FlushInput </td>
446          <td>(</td>
447          <td class="paramtype">void&#160;</td>
448          <td class="paramname"></td><td>)</td>
449          <td></td>
450        </tr>
451      </table>
452  </td>
453  <td class="mlabels-right">
454<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
455  </tr>
456</table>
457</div><div class="memdoc">
458
459<p>Flush input datas. </p>
460
461<p>Implements <a class="el" href="classflair_1_1core_1_1_serial_port.html#aff9d6e015290651328785e94b133445d">flair::core::SerialPort</a>.</p>
462
463</div>
464</div>
465</div><!-- contents -->
466</div><!-- doc-content -->
467<!-- start footer part -->
468<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
469  <ul>
470    <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_r_t_d_m___serial_port.html">RTDM_SerialPort</a></li>
471    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
472    <a href="http://www.doxygen.org/index.html">
473    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
474  </ul>
475</div>
476</body>
477</html>
Note: See TracBrowser for help on using the repository browser.