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

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

doc
File size: 18.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.9.1"/>
7<title>Flair: IODevice.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('_i_o_device_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">IODevice.h</div> </div>
109</div><!--header-->
110<div class="contents">
111<a href="_i_o_device_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="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// ---</span></div>
116<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"></span><span class="preprocessor">#ifndef IO_DEVICE_H</span></div>
117<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define IO_DEVICE_H</span></div>
118<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
119<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_object_8h.html">Object.h</a>&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">class </span>IODevice_impl;</div>
122<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">class </span>Thread_impl;</div>
123<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">class </span>FrameworkManager_impl;</div>
124<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
125<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
126<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span>core {</div>
127<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
128<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">class </span>io_data;</div>
129<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">class </span>DataType;</div>
130<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
131<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_i_o_device.html"> 45</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> {</div>
132<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">friend</span> class ::IODevice_impl;</div>
133<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">friend</span> class ::Thread_impl;</div>
134<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">friend</span> class ::FrameworkManager_impl;</div>
135<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
136<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">public</span>:</div>
137<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name);</div>
138<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
139<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a05246988b486def40926d8491e1bcc5f">~IODevice</a>();</div>
140<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
141<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#af7b42de6bb3893df860063228b55c229">AddDeviceToLog</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *device);</div>
142<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
143<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a2e0b7af75abdbf39843d8bf2e45f08b9">AddDataToLog</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a> *data);</div>
144<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
145<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a12d811c6926fb86da6b47f889109da66">OutputToShMem</a>(<span class="keywordtype">bool</span> enabled);</div>
146<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
147<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#aee7828ae2eece2bace8e476dacc2bc12">IsReady</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div>
148<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
149<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="comment">// TODO: these 2 method should be pure virtual</span></div>
150<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_data_type.html">DataType</a> <span class="keyword">const</span> &amp;GetInputDataType() <span class="keyword">const</span>;</div>
151<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classflair_1_1core_1_1_data_type.html">DataType</a> <span class="keyword">const</span> &amp;GetOutputDataType() <span class="keyword">const</span>;</div>
152<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div>
153<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">protected</span>:</div>
154<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a3df9057ae23eb34f1b1dae8e7a4a9efc">ProcessUpdate</a>(<a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a>* data);</div>
155<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
156<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#a120fdcc3d50f6f076084cb6943fdf412">SetIsReady</a>(<span class="keywordtype">bool</span> status);</div>
157<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;</div>
158<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html#aead8f82fd3133168041c37cc471077d5">UpdateFrom</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">io_data</a> *data) = 0;</div>
159<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div>
160<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keyword">private</span>:</div>
161<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keyword">class </span>IODevice_impl *pimpl_;</div>
162<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;};</div>
163<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;</div>
164<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;} <span class="comment">// end namespace core</span></div>
165<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;} <span class="comment">// end namespace flair</span></div>
166<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;</div>
167<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="preprocessor">#endif // IO_DEVICE_H</span></div>
168<div class="ttc" id="classflair_1_1core_1_1io__data_html"><div class="ttname"><a href="classflair_1_1core_1_1io__data.html">flair::core::io_data</a></div><div class="ttdoc">Abstract class for data types. </div><div class="ttdef"><b>Definition:</b> io_data.h:94</div></div>
169<div class="ttc" id="classflair_1_1core_1_1_data_type_html"><div class="ttname"><a href="classflair_1_1core_1_1_data_type.html">flair::core::DataType</a></div><div class="ttdef"><b>Definition:</b> io_data.h:26</div></div>
170<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>
171<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></div><div class="ttdoc">Abstract class for input/ouput system. </div><div class="ttdef"><b>Definition:</b> IODevice.h:45</div></div>
172<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>
173<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_a3df9057ae23eb34f1b1dae8e7a4a9efc"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#a3df9057ae23eb34f1b1dae8e7a4a9efc">flair::core::IODevice::ProcessUpdate</a></div><div class="ttdeci">void ProcessUpdate(io_data *data)</div><div class="ttdoc">Process the childs of type IODevice, and log if needed. </div></div>
174<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_a2e0b7af75abdbf39843d8bf2e45f08b9"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#a2e0b7af75abdbf39843d8bf2e45f08b9">flair::core::IODevice::AddDataToLog</a></div><div class="ttdeci">void AddDataToLog(const io_data *data)</div><div class="ttdoc">Add an io_data to the log. </div></div>
175<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_a12d811c6926fb86da6b47f889109da66"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#a12d811c6926fb86da6b47f889109da66">flair::core::IODevice::OutputToShMem</a></div><div class="ttdeci">void OutputToShMem(bool enabled)</div><div class="ttdoc">Send the output to a shared memory. </div></div>
176<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_a9693b497752b466891eaafeb34bec4d3"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">flair::core::IODevice::IODevice</a></div><div class="ttdeci">IODevice(const Object *parent, std::string name)</div><div class="ttdoc">Constructor. </div></div>
177<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_aead8f82fd3133168041c37cc471077d5"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#aead8f82fd3133168041c37cc471077d5">flair::core::IODevice::UpdateFrom</a></div><div class="ttdeci">virtual void UpdateFrom(const io_data *data)=0</div><div class="ttdoc">Update using provided datas. </div></div>
178<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>
179<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_a05246988b486def40926d8491e1bcc5f"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#a05246988b486def40926d8491e1bcc5f">flair::core::IODevice::~IODevice</a></div><div class="ttdeci">virtual ~IODevice()</div><div class="ttdoc">Destructor. </div></div>
180<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_a120fdcc3d50f6f076084cb6943fdf412"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#a120fdcc3d50f6f076084cb6943fdf412">flair::core::IODevice::SetIsReady</a></div><div class="ttdeci">void SetIsReady(bool status)</div><div class="ttdoc">set is ready </div></div>
181<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_af7b42de6bb3893df860063228b55c229"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#af7b42de6bb3893df860063228b55c229">flair::core::IODevice::AddDeviceToLog</a></div><div class="ttdeci">void AddDeviceToLog(const IODevice *device)</div><div class="ttdoc">Add an IODevice to the logs. </div></div>
182<div class="ttc" id="classflair_1_1core_1_1_i_o_device_html_aee7828ae2eece2bace8e476dacc2bc12"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html#aee7828ae2eece2bace8e476dacc2bc12">flair::core::IODevice::IsReady</a></div><div class="ttdeci">bool IsReady(void) const </div><div class="ttdoc">is device ready </div></div>
183</div><!-- fragment --></div><!-- contents -->
184</div><!-- doc-content -->
185<!-- start footer part -->
186<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
187 <ul>
188 <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="_i_o_device_8h.html">IODevice.h</a></li>
189 <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
190 <a href="http://www.doxygen.org/index.html">
191 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
192 </ul>
193</div>
194</body>
195</html>
Note: See TracBrowser for help on using the repository browser.