source: flair-dev/tags/0.1.0/doc/Flair/classflair_1_1core_1_1_r_t_d_m___serial_port.html

Last change on this file was 50, checked in by Sanahuja Guillaume, 7 years ago

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