<!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.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_ofdm_frame_sink2.h 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('gr__ofdm__frame__sink2_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">gr_ofdm_frame_sink2.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="gr__ofdm__frame__sink2_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> <span class="comment">/* -*- c++ -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2007,2011 Free Software Foundation, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef INCLUDED_GR_OFDM_FRAME_SINK2_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_OFDM_FRAME_SINK2_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="gr__core__api_8h.html">gr_core_api.h</a>></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="code" href="gr__sync__block_8h.html">gr_sync_block.h</a>></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="code" href="gr__msg__queue_8h.html">gr_msg_queue.h</a>></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <gr_constellation.h></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span><a class="code" href="classgr__ofdm__frame__sink2.html" title="Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs them into packets, and sends to to a message queue sink.NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer. Eventually, we want to be able to pass in a reference to an object to do the demapping and slicing for a given modulation type.">gr_ofdm_frame_sink2</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gr_ofdm_frame_sink2></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_ofdm_frame_sink2_sptr</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_ofdm_frame_sink2_sptr</a></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <a class="code" href="gr__ofdm__frame__sink2_8h.html#a896c0a0dab277b4cdcf742418f922f47">gr_make_ofdm_frame_sink2</a> (gr_constellation_sptr constell,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> occupied_tones,</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">float</span> phase_gain=0.25, <span class="keywordtype">float</span> freq_gain=0.25*0.25/4.0);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * \brief Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * them into packets, and sends to to a message queue sink.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * \ingroup sink_blk</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * \ingroup ofdm_blk</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer. Eventually,</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * we want to be able to pass in a reference to an object to do the demapping and slicing</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * for a given modulation type.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="classgr__ofdm__frame__sink2.html"> 49</a></span> <span class="keyword">class </span><a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classgr__ofdm__frame__sink2.html" title="Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs them into packets, and sends to to a message queue sink.NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer. Eventually, we want to be able to pass in a reference to an object to do the demapping and slicing for a given modulation type.">gr_ofdm_frame_sink2</a> : <span class="keyword">public</span> <a class="code" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing implementa...">gr_sync_block</a></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">friend</span> <a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_ofdm_frame_sink2_sptr</a></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="gr__ofdm__frame__sink2_8h.html#a896c0a0dab277b4cdcf742418f922f47">gr_make_ofdm_frame_sink2</a> (gr_constellation_sptr constell,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> occupied_tones,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">float</span> phase_gain, <span class="keywordtype">float</span> freq_gain);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">enum</span> state_t {STATE_SYNC_SEARCH, STATE_HAVE_SYNC, STATE_HAVE_HEADER};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> MAX_PKT_LEN = 4096;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> HEADERBYTELEN = 4;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> d_target_queue; <span class="comment">// where to send the packet when received</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  state_t d_state;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_header; <span class="comment">// header bits</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">int</span> d_headerbytelen_cnt; <span class="comment">// how many so far</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *d_bytes_out; <span class="comment">// hold the current bytes produced by the demapper</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_occupied_carriers;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_byte_offset;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_partial_byte;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> d_packet[MAX_PKT_LEN]; <span class="comment">// assembled payload</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">int</span> d_packetlen; <span class="comment">// length of packet</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> d_packet_whitener_offset; <span class="comment">// offset into whitener string to use</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">int</span> d_packetlen_cnt; <span class="comment">// how many so far</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> * d_derotated_output; <span class="comment">// Pointer to output stream to send deroated symbols out</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  gr_constellation_sptr d_constell;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  std::vector<gr_complex> d_dfe;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_nbits;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> d_resid;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_nresid;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">float</span> d_phase;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">float</span> d_freq;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">float</span> d_phase_gain;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">float</span> d_freq_gain;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">float</span> d_eq_gain;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::vector<int> d_subcarrier_map;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="classgr__ofdm__frame__sink2.html" title="Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs them into packets, and sends to to a message queue sink.NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer. Eventually, we want to be able to pass in a reference to an object to do the demapping and slicing for a given modulation type.">gr_ofdm_frame_sink2</a>(gr_constellation_sptr constell,</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classboost_1_1shared__ptr.html">gr_msg_queue_sptr</a> target_queue, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> occupied_tones,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">float</span> phase_gain, <span class="keywordtype">float</span> freq_gain);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">void</span> enter_search();</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">void</span> enter_have_sync();</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> enter_have_header();</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="code" href="classgr__ofdm__frame__sink2.html#a4b80946bc6e1d00bcf851ca68bed81d6"> 103</a></span>  <span class="keywordtype">bool</span> header_ok()</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  {</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// confirm that two copies of header info are identical</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">return</span> ((d_header >> 16) ^ (d_header & 0xffff)) == 0;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> slicer(<span class="keyword">const</span> <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> x);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> demapper(<span class="keyword">const</span> <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *in,</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  ~<a class="code" href="classgr__ofdm__frame__sink2.html" title="Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs them into packets, and sends to to a message queue sink.NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer. Eventually, we want to be able to pass in a reference to an object to do the demapping and slicing for a given modulation type.">gr_ofdm_frame_sink2</a>();</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">int</span> <a class="code" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117" title="just like gr_block::general_work, only this arranges to call consume_each for you">work</a>(<span class="keywordtype">int</span> noutput_items,</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <a class="code" href="gr__types_8h.html#a9852a3d906d823cb70eb9c29e7f2a43d">gr_vector_const_void_star</a> &input_items,</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="gr__types_8h.html#acd3f499576e769966ea44554b359d949">gr_vector_void_star</a> &output_items);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> };</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_OFDM_FRAME_SINK2_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_284717b6cb06147531c058220802c6d1.html">gnuradio-core</a></li><li class="navelem"><a class="el" href="dir_7c24473031c549da670035bb20d1e97e.html">src</a></li><li class="navelem"><a class="el" href="dir_84906bae47c76101f1fa015cf813f8a2.html">lib</a></li><li class="navelem"><a class="el" href="dir_a82a9d947ffcded01cd668b1a1a6c872.html">general</a></li><li class="navelem"><a class="el" href="gr__ofdm__frame__sink2_8h.html">gr_ofdm_frame_sink2.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
