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: 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="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">
|
---|
46 | var 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 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 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('_target_eth_controller_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">TargetEthController.h</div> </div>
|
---|
109 | </div><!--header-->
|
---|
110 | <div class="contents">
|
---|
111 | <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// %flair:license{</span></div>
|
---|
112 | <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <span class="comment">// CECILL-C License, Version 1.0.</span></div>
|
---|
114 | <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// %flair:license}</span></div>
|
---|
115 | <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// created: 2015/04/14</span></div>
|
---|
116 | <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// filename: TargetEthController.h</span></div>
|
---|
117 | <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div>
|
---|
118 | <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// author: Gildas Bayard</span></div>
|
---|
119 | <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright Heudiasyc UMR UTC/CNRS 7253</span></div>
|
---|
120 | <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div>
|
---|
121 | <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// version: $Id: $</span></div>
|
---|
122 | <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div>
|
---|
123 | <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// purpose: class that gets remote controls through an ethernet connection.</span></div>
|
---|
124 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// Typical use case: a remote control is plugged in a workstation</span></div>
|
---|
125 | <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// and sends remote control</span></div>
|
---|
126 | <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// data to a distant target (this class) through Wifi</span></div>
|
---|
127 | <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div>
|
---|
128 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//</span></div>
|
---|
129 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/*********************************************************************/</span></div>
|
---|
130 | <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
|
---|
131 | <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef TARGETETHCONTROLLER_H</span></div>
|
---|
132 | <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define TARGETETHCONTROLLER_H</span></div>
|
---|
133 | <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
---|
134 | <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "TargetController.h"</span></div>
|
---|
135 | <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
---|
136 | <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
|
---|
137 | <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>core {</div>
|
---|
138 | <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">class </span>FrameworkManager;</div>
|
---|
139 | <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span>cvmatrix;</div>
|
---|
140 | <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>TcpSocket;</div>
|
---|
141 | <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>Socket;</div>
|
---|
142 | <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> }</div>
|
---|
143 | <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span>gui {</div>
|
---|
144 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Tab;</div>
|
---|
145 | <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>TabWidget;</div>
|
---|
146 | <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>DataPlot1D;</div>
|
---|
147 | <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> }</div>
|
---|
148 | <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> }</div>
|
---|
149 | <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
---|
150 | <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
|
---|
151 | <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">namespace </span>sensor {</div>
|
---|
152 | <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> <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>
|
---|
153 | <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div>
|
---|
154 | <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <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>
|
---|
155 | <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint16_t port, uint8_t priority = 0);</div>
|
---|
156 | <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ~<a class="code" href="classflair_1_1sensor_1_1_target_eth_controller.html">TargetEthController</a>();</div>
|
---|
157 | <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// void DrawUserInterface();</span></div>
|
---|
158 | <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">protected</span>:</div>
|
---|
159 | <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">bool</span> IsConnected() <span class="keyword">const</span>;</div>
|
---|
160 | <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// axis stuff</span></div>
|
---|
161 | <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::string GetAxisName(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> axisId) <span class="keyword">const</span>;</div>
|
---|
162 | <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// button stuff</span></div>
|
---|
163 | <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::string GetButtonName(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> axisId) <span class="keyword">const</span>;</div>
|
---|
164 | <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// controller state stuff</span></div>
|
---|
165 | <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> ProcessMessage(<a class="code" href="classflair_1_1core_1_1_message.html">core::Message</a> *msg);</div>
|
---|
166 | <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> IsControllerActionSupported(ControllerAction action) <span class="keyword">const</span>;</div>
|
---|
167 | <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
---|
168 | <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> IsDataFrameReady();</div>
|
---|
169 | <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> AcquireAxisData(<a class="code" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> &axis); <span class="comment">// responsible for getting the</span></div>
|
---|
170 | <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// axis data from the hardware</span></div>
|
---|
171 | <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> AcquireButtonData(<a class="code" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> &button); <span class="comment">// responsible for getting the</span></div>
|
---|
172 | <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// button data from the</span></div>
|
---|
173 | <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// hardware</span></div>
|
---|
174 | <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
|
---|
175 | <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> ControllerInitialization();</div>
|
---|
176 | <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
|
---|
177 | <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">private</span>:</div>
|
---|
178 | <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  uint16_t readBits(uint8_t offsetInBits, uint8_t valueSizeInBits, <span class="keywordtype">char</span> *buffer,</div>
|
---|
179 | <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">size_t</span> bufferSize);</div>
|
---|
180 | <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  uint8_t getByteOrNull(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">int</span> byte, <span class="keywordtype">size_t</span> bufferSize);</div>
|
---|
181 | <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  uint32_t charBufferToUint32(<span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> bufferSize);</div>
|
---|
182 | <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classflair_1_1core_1_1_tcp_socket.html">core::TcpSocket</a> *listeningSocket;</div>
|
---|
183 | <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">int</span> listeningPort;</div>
|
---|
184 | <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="classflair_1_1core_1_1_tcp_socket.html">core::TcpSocket</a> *controlSocket = NULL;</div>
|
---|
185 | <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="classflair_1_1core_1_1_socket.html">core::Socket</a> *dataSocket;</div>
|
---|
186 | <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  std::string *axisName = NULL;</div>
|
---|
187 | <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::string *buttonName = NULL;</div>
|
---|
188 | <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">size_t</span> dataFrameSize;</div>
|
---|
189 | <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">char</span> *dataFrameBuffer;</div>
|
---|
190 | <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">char</span> *receiveFrameBuffer;</div>
|
---|
191 | <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">size_t</span> receiveCurrentPosition;</div>
|
---|
192 | <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  uint8_t buttonOffset;</div>
|
---|
193 | <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> };</div>
|
---|
194 | <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> }</div>
|
---|
195 | <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> }</div>
|
---|
196 | <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
|
---|
197 | <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif // TARGETCONTROLLER_H</span></div>
|
---|
198 | <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>
|
---|
199 | <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>
|
---|
200 | <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>
|
---|
201 | <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>
|
---|
202 | <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>
|
---|
203 | <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>
|
---|
204 | <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>
|
---|
205 | <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>
|
---|
206 | </div><!-- fragment --></div><!-- contents -->
|
---|
207 | </div><!-- doc-content -->
|
---|
208 | <!-- start footer part -->
|
---|
209 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
---|
210 | <ul>
|
---|
211 | <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>
|
---|
212 | <li class="footer">Generated on Wed Sep 28 2016 07:01:52 for Flair by
|
---|
213 | <a href="http://www.doxygen.org/index.html">
|
---|
214 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
---|
215 | </ul>
|
---|
216 | </div>
|
---|
217 | </body>
|
---|
218 | </html>
|
---|