Files
discoverpixy/emulator_2libs_2_pixy_2src_2pixyinterpreter_8hpp_source.html
2015-05-12 11:12:43 +02:00

186 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>discoverpixy: emulator/libs/Pixy/src/pixyinterpreter.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_199f00bcd9b0045362f41b6724eab9bb.html">emulator</a></li><li class="navelem"><a class="el" href="dir_5e67a00a7b81989d115187745c5becbd.html">libs</a></li><li class="navelem"><a class="el" href="dir_017204e842f691777598906361953075.html">Pixy</a></li><li class="navelem"><a class="el" href="dir_1d6043785e9a6436a0102038a303860d.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pixyinterpreter.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// begin license header</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// This file is part of Pixy CMUcam5 or &quot;Pixy&quot; for short</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// All Pixy source code is provided under the terms of the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// GNU General Public License v2 (http://www.gnu.org/licenses/gpl-2.0.html).</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// Those wishing to use Pixy source code, software and/or</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// technologies under different licensing terms should contact us at</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// cmucam@cs.cmu.edu. Such licensing terms are available for</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// all portions of the Pixy codebase presented here.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// end license header</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#ifndef __PIXYINTERPRETER_HPP__</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define __PIXYINTERPRETER_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;pixytypes.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;pixy.h&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;pixydefs.h&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;usblink.h&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;interpreter.hpp&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;chirpreceiver.hpp&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#define PIXY_BLOCK_CAPACITY 250</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">class </span><a class="code" href="class_pixy_interpreter.html">PixyInterpreter</a> : <span class="keyword">public</span> <a class="code" href="class_interpreter.html">Interpreter</a></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="class_pixy_interpreter.html">PixyInterpreter</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; ~<a class="code" href="class_pixy_interpreter.html">PixyInterpreter</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_pixy_interpreter.html#a484a346dbd5cf11ef73b8ee8022d12ba">init</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_pixy_interpreter.html#a84513fe3bb46dfbf053f214e141c170d">close</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_pixy_interpreter.html#a9328d917dc4cc7e5f8886e59e4b79848">blocks_are_new</a>();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_pixy_interpreter.html#ad9b879b5f8c5f93aa47524223c201506">get_blocks</a>(<span class="keywordtype">int</span> max_blocks, <a class="code" href="struct_block.html">Block</a> * blocks);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_pixy_interpreter.html#a92a167894ea44a4c566de34990bdc64a">send_command</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * name, va_list arguments);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">int</span> <a class="code" href="class_pixy_interpreter.html#a92a167894ea44a4c566de34990bdc64a">send_command</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * name, ...);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">int</span> service();</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <a class="code" href="class_chirp_receiver.html">ChirpReceiver</a> * receiver_;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="class_u_s_b_link.html">USBLink</a> link_;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; std::vector&lt;Block&gt; blocks_;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordtype">bool</span> blocks_are_new_;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keywordtype">bool</span> init_;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordtype">void</span> interpret_data(<span class="keyword">const</span> <span class="keywordtype">void</span> * chrip_data[]);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keywordtype">void</span> interpret_CCB1(<span class="keyword">const</span> <span class="keywordtype">void</span> * data[]);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordtype">void</span> interpret_CCB2(<span class="keyword">const</span> <span class="keywordtype">void</span> * data[]);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordtype">void</span> add_normal_blocks(<span class="keyword">const</span> <a class="code" href="struct_blob_a.html">BlobA</a> * blocks, uint32_t count);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordtype">void</span> add_color_code_blocks(<span class="keyword">const</span> <a class="code" href="struct_blob_b.html">BlobB</a> * blocks, uint32_t count);</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;};</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="class_pixy_interpreter_html_a92a167894ea44a4c566de34990bdc64a"><div class="ttname"><a href="class_pixy_interpreter.html#a92a167894ea44a4c566de34990bdc64a">PixyInterpreter::send_command</a></div><div class="ttdeci">int send_command(const char *name, va_list arguments)</div><div class="ttdoc">Sends a command to Pixy. </div><div class="ttdef"><b>Definition:</b> pixyinterpreter.cpp:100</div></div>
<div class="ttc" id="class_pixy_interpreter_html_ad9b879b5f8c5f93aa47524223c201506"><div class="ttname"><a href="class_pixy_interpreter.html#ad9b879b5f8c5f93aa47524223c201506">PixyInterpreter::get_blocks</a></div><div class="ttdeci">int get_blocks(int max_blocks, Block *blocks)</div><div class="ttdoc">Copies up to &#39;max_blocks&#39; number of Blocks to the address pointed to by &#39;blocks&#39;. ...</div><div class="ttdef"><b>Definition:</b> pixyinterpreter.cpp:64</div></div>
<div class="ttc" id="class_pixy_interpreter_html_a84513fe3bb46dfbf053f214e141c170d"><div class="ttname"><a href="class_pixy_interpreter.html#a84513fe3bb46dfbf053f214e141c170d">PixyInterpreter::close</a></div><div class="ttdeci">void close()</div><div class="ttdoc">Terminates the USB connection to Pixy and the &#39;iterpreter&#39; thread. </div><div class="ttdef"><b>Definition:</b> pixyinterpreter.cpp:54</div></div>
<div class="ttc" id="struct_blob_a_html"><div class="ttname"><a href="struct_blob_a.html">BlobA</a></div><div class="ttdef"><b>Definition:</b> pixytypes.h:133</div></div>
<div class="ttc" id="class_chirp_receiver_html"><div class="ttname"><a href="class_chirp_receiver.html">ChirpReceiver</a></div><div class="ttdef"><b>Definition:</b> chirpreceiver.hpp:23</div></div>
<div class="ttc" id="class_u_s_b_link_html"><div class="ttname"><a href="class_u_s_b_link.html">USBLink</a></div><div class="ttdef"><b>Definition:</b> usblink.h:6</div></div>
<div class="ttc" id="struct_blob_b_html"><div class="ttname"><a href="struct_blob_b.html">BlobB</a></div><div class="ttdef"><b>Definition:</b> pixytypes.h:156</div></div>
<div class="ttc" id="class_pixy_interpreter_html_a484a346dbd5cf11ef73b8ee8022d12ba"><div class="ttname"><a href="class_pixy_interpreter.html#a484a346dbd5cf11ef73b8ee8022d12ba">PixyInterpreter::init</a></div><div class="ttdeci">int init()</div><div class="ttdoc">Spawns an &#39;interpreter&#39; thread which attempts to connect to Pixy using the USB interface. On successful connection, this thread will capture and store Pixy &#39;block&#39; object data which can be retreived using the getBlocks() method. </div><div class="ttdef"><b>Definition:</b> pixyinterpreter.cpp:31</div></div>
<div class="ttc" id="class_pixy_interpreter_html"><div class="ttname"><a href="class_pixy_interpreter.html">PixyInterpreter</a></div><div class="ttdef"><b>Definition:</b> pixyinterpreter.hpp:29</div></div>
<div class="ttc" id="class_interpreter_html"><div class="ttname"><a href="class_interpreter.html">Interpreter</a></div><div class="ttdef"><b>Definition:</b> interpreter.hpp:19</div></div>
<div class="ttc" id="class_pixy_interpreter_html_a9328d917dc4cc7e5f8886e59e4b79848"><div class="ttname"><a href="class_pixy_interpreter.html#a9328d917dc4cc7e5f8886e59e4b79848">PixyInterpreter::blocks_are_new</a></div><div class="ttdeci">int blocks_are_new()</div><div class="ttdoc">Get status of the block data received from Pixy. </div><div class="ttdef"><b>Definition:</b> pixyinterpreter.cpp:289</div></div>
<div class="ttc" id="struct_block_html"><div class="ttname"><a href="struct_block.html">Block</a></div><div class="ttdef"><b>Definition:</b> pixy.h:47</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:17 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>