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

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

m

File size: 21.2 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: TargetEthController.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="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><a href="annotated.html"><span>Classes</span></a></li>
51      <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
73    </ul>
74  </div>
75</div><!-- top -->
76<div id="side-nav" class="ui-resizable side-nav-resizable">
77  <div id="nav-tree">
78    <div id="nav-tree-contents">
79      <div id="nav-sync" class="sync"></div>
80    </div>
81  </div>
82  <div id="splitbar" style="-moz-user-select:none;" 
83       class="ui-resizable-handle">
84  </div>
85</div>
86<script type="text/javascript">
87$(document).ready(function(){initNavTree('_target_eth_controller_8h_source.html','');});
88</script>
89<div id="doc-content">
90<!-- window showing the filter options -->
91<div id="MSearchSelectWindow"
92     onmouseover="return searchBox.OnSearchSelectShow()"
93     onmouseout="return searchBox.OnSearchSelectHide()"
94     onkeydown="return searchBox.OnSearchSelectKey(event)">
95<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>
96
97<!-- iframe showing the search results (closed by default) -->
98<div id="MSearchResultsWindow">
99<iframe src="javascript:void(0)" frameborder="0" 
100        name="MSearchResults" id="MSearchResults">
101</iframe>
102</div>
103
104<div class="header">
105  <div class="headertitle">
106<div class="title">TargetEthController.h</div>  </div>
107</div><!--header-->
108<div class="contents">
109<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// %flair:license{</span></div>
110<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>
111<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// CECILL-C License, Version 1.0.</span></div>
112<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// %flair:license}</span></div>
113<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//  created:    2015/04/14</span></div>
114<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">//  filename:   TargetEthController.h</span></div>
115<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div>
116<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//  author:     Gildas Bayard</span></div>
117<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">//              Copyright Heudiasyc UMR UTC/CNRS 7253</span></div>
118<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">//</span></div>
119<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">//  version:    $Id: $</span></div>
120<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//</span></div>
121<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">//  purpose:    class that gets remote controls through an ethernet connection.</span></div>
122<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">//              Typical use case: a remote control is plugged in a workstation</span></div>
123<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">//              and sends remote control</span></div>
124<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">//              data to a distant target (this class) through Wifi</span></div>
125<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">//</span></div>
126<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">//</span></div>
127<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">/*********************************************************************/</span></div>
128<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
129<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#ifndef TARGETETHCONTROLLER_H</span></div>
130<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#define TARGETETHCONTROLLER_H</span></div>
131<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div>
132<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#include &quot;TargetController.h&quot;</span></div>
133<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
134<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">namespace </span>flair {</div>
135<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">namespace </span>core {</div>
136<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">class </span>FrameworkManager;</div>
137<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">class </span>cvmatrix;</div>
138<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">class </span>TcpSocket;</div>
139<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">class </span>Socket;</div>
140<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;}</div>
141<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">namespace </span>gui {</div>
142<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">class </span>Tab;</div>
143<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">class </span>TabWidget;</div>
144<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="keyword">class </span>DataPlot1D;</div>
145<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;}</div>
146<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;}</div>
147<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
148<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">namespace </span>flair {</div>
149<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">namespace </span>sensor {</div>
150<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classflair_1_1sensor_1_1_target_eth_controller.html">   47</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1sensor_1_1_target_eth_controller.html">TargetEthController</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1sensor_1_1_target_controller.html">TargetController</a> {</div>
151<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keyword">public</span>:</div>
152<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <a class="code" href="classflair_1_1sensor_1_1_target_eth_controller.html">TargetEthController</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *parent, std::string name,</div>
153<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;                      uint16_t port, uint8_t priority = 0);</div>
154<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  ~<a class="code" href="classflair_1_1sensor_1_1_target_eth_controller.html">TargetEthController</a>();</div>
155<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="comment">// void DrawUserInterface();</span></div>
156<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="keyword">protected</span>:</div>
157<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  <span class="keywordtype">bool</span> IsConnected() <span class="keyword">const</span>;</div>
158<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <span class="comment">// axis stuff</span></div>
159<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  std::string GetAxisName(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> axisId) <span class="keyword">const</span>;</div>
160<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <span class="comment">// button stuff</span></div>
161<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  std::string GetButtonName(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> axisId) <span class="keyword">const</span>;</div>
162<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  <span class="comment">// controller state stuff</span></div>
163<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  <span class="keywordtype">bool</span> ProcessMessage(<a class="code" href="classflair_1_1core_1_1_message.html">core::Message</a> *msg);</div>
164<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  <span class="keywordtype">bool</span> IsControllerActionSupported(ControllerAction action) <span class="keyword">const</span>;</div>
165<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
166<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <span class="keywordtype">bool</span> IsDataFrameReady();</div>
167<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="keywordtype">void</span> AcquireAxisData(<a class="code" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> &amp;axis); <span class="comment">// responsible for getting the</span></div>
168<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;                                              <span class="comment">// axis data from the hardware</span></div>
169<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  <span class="keywordtype">void</span> AcquireButtonData(<a class="code" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> &amp;button); <span class="comment">// responsible for getting the</span></div>
170<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                                                  <span class="comment">// button data from the</span></div>
171<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                                                  <span class="comment">// hardware</span></div>
172<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
173<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  <span class="keywordtype">bool</span> ControllerInitialization();</div>
174<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
175<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="keyword">private</span>:</div>
176<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;  uint16_t readBits(uint8_t offsetInBits, uint8_t valueSizeInBits, <span class="keywordtype">char</span> *buffer,</div>
177<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                    <span class="keywordtype">size_t</span> bufferSize);</div>
178<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  uint8_t getByteOrNull(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> byte, <span class="keywordtype">size_t</span> bufferSize);</div>
179<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;  uint32_t charBufferToUint32(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> bufferSize);</div>
180<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <a class="code" href="classflair_1_1core_1_1_tcp_socket.html">core::TcpSocket</a> *listeningSocket;</div>
181<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  <span class="keywordtype">int</span> listeningPort;</div>
182<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <a class="code" href="classflair_1_1core_1_1_tcp_socket.html">core::TcpSocket</a> *controlSocket = NULL;</div>
183<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <a class="code" href="classflair_1_1core_1_1_socket.html">core::Socket</a> *dataSocket;</div>
184<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  std::string *axisName = NULL;</div>
185<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  std::string *buttonName = NULL;</div>
186<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;  <span class="keywordtype">size_t</span> dataFrameSize;</div>
187<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;  <span class="keywordtype">char</span> *dataFrameBuffer;</div>
188<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  <span class="keywordtype">char</span> *receiveFrameBuffer;</div>
189<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keywordtype">size_t</span> receiveCurrentPosition;</div>
190<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;  uint8_t buttonOffset;</div>
191<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;};</div>
192<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;}</div>
193<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;}</div>
194<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
195<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="preprocessor">#endif // TARGETCONTROLLER_H</span></div>
196<div class="ttc" id="classflair_1_1core_1_1cvmatrix_html"><div class="ttname"><a href="classflair_1_1core_1_1cvmatrix.html">flair::core::cvmatrix</a></div><div class="ttdoc">Class defining a matrix of kind CvMat. </div><div class="ttdef"><b>Definition:</b> cvmatrix.h:33</div></div>
197<div class="ttc" id="classflair_1_1core_1_1_tcp_socket_html"><div class="ttname"><a href="classflair_1_1core_1_1_tcp_socket.html">flair::core::TcpSocket</a></div><div class="ttdoc">Class encapsulating a TCP socket. </div><div class="ttdef"><b>Definition:</b> TcpSocket.h:25</div></div>
198<div class="ttc" id="classflair_1_1core_1_1_socket_html"><div class="ttname"><a href="classflair_1_1core_1_1_socket.html">flair::core::Socket</a></div><div class="ttdoc">Class encapsulating a UDP socket. It assumes packets are coming from only one distant host on a given...</div><div class="ttdef"><b>Definition:</b> Socket.h:31</div></div>
199<div class="ttc" id="classflair_1_1sensor_1_1_target_controller_html"><div class="ttname"><a href="classflair_1_1sensor_1_1_target_controller.html">flair::sensor::TargetController</a></div><div class="ttdoc">Base Class for target side remote controls. </div><div class="ttdef"><b>Definition:</b> TargetController.h:49</div></div>
200<div class="ttc" id="classflair_1_1core_1_1_framework_manager_html"><div class="ttname"><a href="classflair_1_1core_1_1_framework_manager.html">flair::core::FrameworkManager</a></div><div class="ttdoc">Main class of the Framework library. </div><div class="ttdef"><b>Definition:</b> FrameworkManager.h:45</div></div>
201<div class="ttc" id="classflair_1_1sensor_1_1_target_eth_controller_html"><div class="ttname"><a href="classflair_1_1sensor_1_1_target_eth_controller.html">flair::sensor::TargetEthController</a></div><div class="ttdef"><b>Definition:</b> TargetEthController.h:47</div></div>
202<div class="ttc" id="classflair_1_1core_1_1_message_html"><div class="ttname"><a href="classflair_1_1core_1_1_message.html">flair::core::Message</a></div><div class="ttdef"><b>Definition:</b> Object.h:35</div></div>
203</div><!-- fragment --></div><!-- contents -->
204</div><!-- doc-content -->
205<!-- start footer part -->
206<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
207  <ul>
208    <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_6e0f9c50eed172896c55a6e61952176b.html">FlairSensorActuator</a></li><li class="navelem"><a class="el" href="dir_c5d95abdcafe7d1171548eb561d7ce37.html">src</a></li><li class="navelem"><b>TargetEthController.h</b></li>
209    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
210    <a href="http://www.doxygen.org/index.html">
211    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
212  </ul>
213</div>
214</body>
215</html>
Note: See TracBrowser for help on using the repository browser.