source: flair-dev/trunk/doc/Flair/_serial_port_8h_source.html

Last change on this file was 100, checked in by Sanahuja Guillaume, 6 years ago

doc
File size: 14.8 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: SerialPort.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
53 <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
75 </ul>
76 </div>
77</div><!-- top -->
78<div id="side-nav" class="ui-resizable side-nav-resizable">
79 <div id="nav-tree">
80 <div id="nav-tree-contents">
81 <div id="nav-sync" class="sync"></div>
82 </div>
83 </div>
84 <div id="splitbar" style="-moz-user-select:none;"
85 class="ui-resizable-handle">
86 </div>
87</div>
88<script type="text/javascript">
89$(document).ready(function(){initNavTree('_serial_port_8h_source.html','');});
90</script>
91<div id="doc-content">
92<!-- window showing the filter options -->
93<div id="MSearchSelectWindow"
94 onmouseover="return searchBox.OnSearchSelectShow()"
95 onmouseout="return searchBox.OnSearchSelectHide()"
96 onkeydown="return searchBox.OnSearchSelectKey(event)">
97</div>
98
99<!-- iframe showing the search results (closed by default) -->
100<div id="MSearchResultsWindow">
101<iframe src="javascript:void(0)" frameborder="0"
102 name="MSearchResults" id="MSearchResults">
103</iframe>
104</div>
105
106<div class="header">
107 <div class="headertitle">
108<div class="title">SerialPort.h</div> </div>
109</div><!--header-->
110<div class="contents">
111<a href="_serial_port_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// %flair:license{</span></div>
112<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// This file is part of the Flair framework distributed under the</span></div>
113<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// CECILL-C License, Version 1.0.</span></div>
114<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// %flair:license}</span></div>
115<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"></span><span class="preprocessor">#ifndef SERIALPORT_H</span></div>
116<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define SERIALPORT_H</span></div>
117<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
118<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_object_8h.html">Object.h</a>&gt;</span></div>
119<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
120<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
121<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
122<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span>core {</div>
123<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_serial_port.html"> 25</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_serial_port.html">SerialPort</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> {</div>
124<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">public</span>:</div>
125<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_serial_port.html#aa6f8c5f8c8a9e435635b1730feebc90c"> 35</a></span>&#160; <a class="code" href="classflair_1_1core_1_1_serial_port.html#aa6f8c5f8c8a9e435635b1730feebc90c">SerialPort</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name) : <a class="code" href="classflair_1_1core_1_1_object.html">Object</a>(parent, name) {}</div>
126<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
127<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_serial_port.html#aeb4eab5de344483667176a101607bb68"> 41</a></span>&#160; <a class="code" href="classflair_1_1core_1_1_serial_port.html#aeb4eab5de344483667176a101607bb68">~SerialPort</a>(){};</div>
128<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
129<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_serial_port.html#ad9f27342a1d501d7cd64eb3a215572fe">SetBaudrate</a>(<span class="keywordtype">int</span> baudrate) = 0;</div>
130<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
131<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_serial_port.html#a54b5711f111f84656201dcd2ac2c03cf">SetRxTimeout</a>(<a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns) = 0;</div>
132<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
133<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">virtual</span> ssize_t <a class="code" href="classflair_1_1core_1_1_serial_port.html#ac67f66b90f567de20b77afc287504740">Write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> nbyte) = 0;</div>
134<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div>
135<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">virtual</span> ssize_t <a class="code" href="classflair_1_1core_1_1_serial_port.html#a5e9f8971fc5ea70a2d66a771c6e7d711">Read</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> nbyte) = 0;</div>
136<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
137<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_serial_port.html#aff9d6e015290651328785e94b133445d">FlushInput</a>(<span class="keywordtype">void</span>) = 0;</div>
138<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;};</div>
139<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;} <span class="comment">// end namespace core</span></div>
140<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;} <span class="comment">// end namespace flair</span></div>
141<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
142<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif // SERIALPORT_H</span></div>
143<div class="ttc" id="classflair_1_1core_1_1_object_html"><div class="ttname"><a href="classflair_1_1core_1_1_object.html">flair::core::Object</a></div><div class="ttdoc">Base class for all Framework&#39;s classes. </div><div class="ttdef"><b>Definition:</b> Object.h:83</div></div>
144<div class="ttc" id="classflair_1_1core_1_1_serial_port_html_ac67f66b90f567de20b77afc287504740"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html#ac67f66b90f567de20b77afc287504740">flair::core::SerialPort::Write</a></div><div class="ttdeci">virtual ssize_t Write(const void *buf, size_t nbyte)=0</div><div class="ttdoc">Write datas. </div></div>
145<div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div>
146<div class="ttc" id="namespaceflair_1_1core_html_acc0fa041e08ecf73b2d1d723c339a736"><div class="ttname"><a href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">flair::core::Time</a></div><div class="ttdeci">unsigned long long Time</div><div class="ttdoc">Time definition, in ns. </div><div class="ttdef"><b>Definition:</b> Object.h:55</div></div>
147<div class="ttc" id="classflair_1_1core_1_1_serial_port_html_aa6f8c5f8c8a9e435635b1730feebc90c"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html#aa6f8c5f8c8a9e435635b1730feebc90c">flair::core::SerialPort::SerialPort</a></div><div class="ttdeci">SerialPort(const Object *parent, std::string name)</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> SerialPort.h:35</div></div>
148<div class="ttc" id="classflair_1_1core_1_1_serial_port_html_a54b5711f111f84656201dcd2ac2c03cf"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html#a54b5711f111f84656201dcd2ac2c03cf">flair::core::SerialPort::SetRxTimeout</a></div><div class="ttdeci">virtual void SetRxTimeout(Time timeout_ns)=0</div><div class="ttdoc">Set RX timeout. </div></div>
149<div class="ttc" id="classflair_1_1core_1_1_serial_port_html"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html">flair::core::SerialPort</a></div><div class="ttdoc">Base class for serial port. </div><div class="ttdef"><b>Definition:</b> SerialPort.h:25</div></div>
150<div class="ttc" id="_object_8h_html"><div class="ttname"><a href="_object_8h.html">Object.h</a></div><div class="ttdoc">Base class for all Framework&#39;s classes. </div></div>
151<div class="ttc" id="classflair_1_1core_1_1_serial_port_html_aeb4eab5de344483667176a101607bb68"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html#aeb4eab5de344483667176a101607bb68">flair::core::SerialPort::~SerialPort</a></div><div class="ttdeci">~SerialPort()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> SerialPort.h:41</div></div>
152<div class="ttc" id="classflair_1_1core_1_1_serial_port_html_aff9d6e015290651328785e94b133445d"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html#aff9d6e015290651328785e94b133445d">flair::core::SerialPort::FlushInput</a></div><div class="ttdeci">virtual void FlushInput(void)=0</div><div class="ttdoc">Flush input datas. </div></div>
153<div class="ttc" id="classflair_1_1core_1_1_serial_port_html_ad9f27342a1d501d7cd64eb3a215572fe"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html#ad9f27342a1d501d7cd64eb3a215572fe">flair::core::SerialPort::SetBaudrate</a></div><div class="ttdeci">virtual void SetBaudrate(int baudrate)=0</div><div class="ttdoc">Set baudrate. </div></div>
154<div class="ttc" id="classflair_1_1core_1_1_serial_port_html_a5e9f8971fc5ea70a2d66a771c6e7d711"><div class="ttname"><a href="classflair_1_1core_1_1_serial_port.html#a5e9f8971fc5ea70a2d66a771c6e7d711">flair::core::SerialPort::Read</a></div><div class="ttdeci">virtual ssize_t Read(void *buf, size_t nbyte)=0</div><div class="ttdoc">Read datas. </div></div>
155</div><!-- fragment --></div><!-- contents -->
156</div><!-- doc-content -->
157<!-- start footer part -->
158<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
159 <ul>
160 <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_97265977dbbd48c696782ccac102bad5.html">FlairCore</a></li><li class="navelem"><a class="el" href="dir_6c198461db290ac9abcdd44184573216.html">src</a></li><li class="navelem"><a class="el" href="_serial_port_8h.html">SerialPort.h</a></li>
161 <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
162 <a href="http://www.doxygen.org/index.html">
163 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
164 </ul>
165</div>
166</body>
167</html>
Note: See TracBrowser for help on using the repository browser.