Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 4836

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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"/>
<title>GNU Radio 3.2.2 C++ API: gr_ofdm_frame_sink.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('gr__ofdm__frame__sink_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gr_ofdm_frame_sink.h</h1>  </div>
</div>
<div class="contents">
<a href="gr__ofdm__frame__sink_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2007 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_OFDM_FRAME_SINK_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_OFDM_FRAME_SINK_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;gr_sync_block.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;gr_msg_queue.h&gt;</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classgr__ofdm__frame__sink.html" title="Takes an OFDM symbol in, demaps it into bits of 0&amp;#39;s and 1&amp;#39;s, packs them into packets...">gr_ofdm_frame_sink</a>;
<a name="l00030"></a>00030 <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr&lt;gr_ofdm_frame_sink&gt;</a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_ofdm_frame_sink_sptr</a>;
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_ofdm_frame_sink_sptr</a> 
<a name="l00033"></a>00033 <a class="code" href="gr__ofdm__frame__sink_8h.html#a24144f4a7e5ff890de27f5c6258cd658">gr_make_ofdm_frame_sink</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a> &amp;sym_position, 
<a name="l00034"></a>00034                          <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a> &amp;sym_value_out,
<a name="l00035"></a>00035                          <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_msg_queue_sptr</a> target_queue, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> occupied_tones,
<a name="l00036"></a>00036                          <span class="keywordtype">float</span> phase_gain=0.25, <span class="keywordtype">float</span> freq_gain=0.25*0.25/4.0);
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/*!</span>
<a name="l00039"></a>00039 <span class="comment"> * \brief Takes an OFDM symbol in, demaps it into bits of 0&#39;s and 1&#39;s, packs</span>
<a name="l00040"></a>00040 <span class="comment"> * them into packets, and sends to to a message queue sink.</span>
<a name="l00041"></a>00041 <span class="comment"> * \ingroup sink_blk</span>
<a name="l00042"></a>00042 <span class="comment"> * \ingroup ofdm_blk</span>
<a name="l00043"></a>00043 <span class="comment"> *</span>
<a name="l00044"></a>00044 <span class="comment"> * NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer. Eventually,</span>
<a name="l00045"></a>00045 <span class="comment"> * we want to be able to pass in a reference to an object to do the demapping and slicing</span>
<a name="l00046"></a>00046 <span class="comment"> * for a given modulation type.</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a><a class="code" href="classgr__ofdm__frame__sink.html">00048</a> <span class="keyword">class </span><a class="code" href="classgr__ofdm__frame__sink.html" title="Takes an OFDM symbol in, demaps it into bits of 0&amp;#39;s and 1&amp;#39;s, packs them into packets...">gr_ofdm_frame_sink</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>
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050   <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_ofdm_frame_sink_sptr</a> 
<a name="l00051"></a>00051   <a class="code" href="classgr__ofdm__frame__sink.html#ae6326404ed8917c076d888f1e3c3e50f">gr_make_ofdm_frame_sink</a> (<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a> &amp;sym_position, 
<a name="l00052"></a>00052                            <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a> &amp;sym_value_out,
<a name="l00053"></a>00053                            <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,
<a name="l00054"></a>00054                            <span class="keywordtype">float</span> phase_gain, <span class="keywordtype">float</span> freq_gain);
<a name="l00055"></a>00055 
<a name="l00056"></a>00056  <span class="keyword">private</span>:
<a name="l00057"></a>00057   <span class="keyword">enum</span> state_t {STATE_SYNC_SEARCH, STATE_HAVE_SYNC, STATE_HAVE_HEADER};
<a name="l00058"></a>00058 
<a name="l00059"></a>00059   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> MAX_PKT_LEN    = 4096;
<a name="l00060"></a>00060   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> HEADERBYTELEN   = 4;
<a name="l00061"></a>00061 
<a name="l00062"></a>00062   <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>
<a name="l00063"></a>00063   state_t            d_state;
<a name="l00064"></a>00064   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>       d_header;                  <span class="comment">// header bits</span>
<a name="l00065"></a>00065   <span class="keywordtype">int</span>                d_headerbytelen_cnt;       <span class="comment">// how many so far</span>
<a name="l00066"></a>00066 
<a name="l00067"></a>00067   <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>
<a name="l00068"></a>00068 
<a name="l00069"></a>00069   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>       d_occupied_carriers;
<a name="l00070"></a>00070   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>       d_byte_offset;
<a name="l00071"></a>00071   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>       d_partial_byte;
<a name="l00072"></a>00072 
<a name="l00073"></a>00073   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>      d_packet[MAX_PKT_LEN];     <span class="comment">// assembled payload</span>
<a name="l00074"></a>00074   <span class="keywordtype">int</span>                d_packetlen;               <span class="comment">// length of packet</span>
<a name="l00075"></a>00075   <span class="keywordtype">int</span>                d_packet_whitener_offset;  <span class="comment">// offset into whitener string to use</span>
<a name="l00076"></a>00076   <span class="keywordtype">int</span>                d_packetlen_cnt;           <span class="comment">// how many so far</span>
<a name="l00077"></a>00077 
<a name="l00078"></a>00078   <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>
<a name="l00079"></a>00079 
<a name="l00080"></a>00080   <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a>    d_sym_position;
<a name="l00081"></a>00081   <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a> d_sym_value_out;
<a name="l00082"></a>00082   <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a>    d_dfe;
<a name="l00083"></a>00083   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_nbits;
<a name="l00084"></a>00084 
<a name="l00085"></a>00085   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> d_resid;
<a name="l00086"></a>00086   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_nresid;
<a name="l00087"></a>00087   <span class="keywordtype">float</span> d_phase;
<a name="l00088"></a>00088   <span class="keywordtype">float</span> d_freq;
<a name="l00089"></a>00089   <span class="keywordtype">float</span> d_phase_gain;
<a name="l00090"></a>00090   <span class="keywordtype">float</span> d_freq_gain;
<a name="l00091"></a>00091   <span class="keywordtype">float</span> d_eq_gain;
<a name="l00092"></a>00092 
<a name="l00093"></a>00093   <a class="code" href="classstd_1_1vector.html">std::vector&lt;int&gt;</a> d_subcarrier_map;
<a name="l00094"></a>00094 
<a name="l00095"></a>00095  <span class="keyword">protected</span>:
<a name="l00096"></a>00096   <a class="code" href="classgr__ofdm__frame__sink.html#a4c70885da3dccf6e629b755d24021294">gr_ofdm_frame_sink</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a> &amp;sym_position, 
<a name="l00097"></a>00097                      <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a> &amp;sym_value_out,
<a name="l00098"></a>00098                      <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,
<a name="l00099"></a>00099                      <span class="keywordtype">float</span> phase_gain, <span class="keywordtype">float</span> freq_gain);
<a name="l00100"></a>00100 
<a name="l00101"></a>00101   <span class="keywordtype">void</span> <a class="code" href="classgr__ofdm__frame__sink.html#a3cf5140b2d7b665b66ef1b9ffb0714ea">enter_search</a>();
<a name="l00102"></a>00102   <span class="keywordtype">void</span> <a class="code" href="classgr__ofdm__frame__sink.html#aa632ea6f0d13403e564f56b0687aae66">enter_have_sync</a>();
<a name="l00103"></a>00103   <span class="keywordtype">void</span> <a class="code" href="classgr__ofdm__frame__sink.html#a6faac7711732a155c65a3c7707266415">enter_have_header</a>();
<a name="l00104"></a>00104   
<a name="l00105"></a><a class="code" href="classgr__ofdm__frame__sink.html#aa510595d0cc0bc55c7a4ae647cf229bd">00105</a>   <span class="keywordtype">bool</span> <a class="code" href="classgr__ofdm__frame__sink.html#aa510595d0cc0bc55c7a4ae647cf229bd">header_ok</a>()
<a name="l00106"></a>00106   {
<a name="l00107"></a>00107     <span class="comment">// confirm that two copies of header info are identical</span>
<a name="l00108"></a>00108     <span class="keywordflow">return</span> ((d_header &gt;&gt; 16) ^ (d_header &amp; 0xffff)) == 0;
<a name="l00109"></a>00109   }
<a name="l00110"></a>00110   
<a name="l00111"></a>00111   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="classgr__ofdm__frame__sink.html#a0d478f55e3b444de83dfae334531814a">slicer</a>(<span class="keyword">const</span> <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> x);
<a name="l00112"></a>00112   <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__ofdm__frame__sink.html#ab38ea04690149eaaaf1e963050183737">demapper</a>(<span class="keyword">const</span> <a class="code" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> *in,
<a name="l00113"></a>00113                         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *out);
<a name="l00114"></a>00114 
<a name="l00115"></a>00115   <span class="keywordtype">bool</span> <a class="code" href="classgr__ofdm__frame__sink.html#a94060d9740588572cae62914e527a558">set_sym_value_out</a>(<span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;gr_complex&gt;</a> &amp;sym_position, 
<a name="l00116"></a>00116                          <span class="keyword">const</span> <a class="code" href="classstd_1_1vector.html">std::vector&lt;unsigned char&gt;</a> &amp;sym_value_out);
<a name="l00117"></a>00117 
<a name="l00118"></a>00118  <span class="keyword">public</span>:
<a name="l00119"></a>00119   <a class="code" href="classgr__ofdm__frame__sink.html#a4408441371b0a5b1b64be1d959b2381b">~gr_ofdm_frame_sink</a>();
<a name="l00120"></a>00120 
<a name="l00121"></a>00121   <span class="keywordtype">int</span> <a class="code" href="classgr__ofdm__frame__sink.html#a9cbbd6669ff730bc510c7f13b0517920" 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,
<a name="l00122"></a>00122            <a class="code" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items,
<a name="l00123"></a>00123            <a class="code" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items);
<a name="l00124"></a>00124 };
<a name="l00125"></a>00125 
<a name="l00126"></a>00126 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_OFDM_FRAME_SINK_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gr__ofdm__frame__sink_8h.html">gr_ofdm_frame_sink.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>