<!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_insert_preamble Class Reference</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('classgr__ofdm__insert__preamble.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#friends">Friends</a> </div> <div class="headertitle"> <h1>gr_ofdm_insert_preamble Class Reference<div class="ingroups"><a class="el" href="group__sync__blk.html">Synchronization</a> | <a class="el" href="group__ofdm__blk.html">OFDM Blocks</a></div></h1> </div> </div> <div class="contents"> <!-- doxytag: class="gr_ofdm_insert_preamble" --><!-- doxytag: inherits="gr_block" --> <p>insert "pre-modulated" preamble symbols before each payload. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__ofdm__insert__preamble_8h_source.html">gr_ofdm_insert_preamble.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_ofdm_insert_preamble:</div> <div class="dyncontent"> <div class="center"><img src="classgr__ofdm__insert__preamble__inherit__graph.png" border="0" usemap="#gr__ofdm__insert__preamble_inherit__map" alt="Inheritance graph"/></div> <map name="gr__ofdm__insert__preamble_inherit__map" id="gr__ofdm__insert__preamble_inherit__map"> <area shape="rect" id="node2" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing flow is cons..." alt="" coords="55,83,124,112"/><area shape="rect" id="node4" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ..." alt="" coords="35,5,144,35"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__ofdm__insert__preamble-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__ofdm__insert__preamble.html#a59263b9b1c692b4f69810bcb94d4351d">~gr_ofdm_insert_preamble</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__ofdm__insert__preamble.html#ad79e088f4effd76866d25d6eeafb7ef8">general_work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">compute output items from input items <a href="#ad79e088f4effd76866d25d6eeafb7ef8"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__ofdm__insert__preamble.html#ad114eb21de28a341f46001727d728fc5">gr_ofdm_insert_preamble</a> (int fft_length, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > > &preamble)</td></tr> <tr><td colspan="2"><h2><a name="friends"></a> Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_ofdm_insert_preamble_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__ofdm__insert__preamble.html#a978133681920731a247d286fb078f796">gr_make_ofdm_insert_preamble</a> (int fft_length, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > > &preamble)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>insert "pre-modulated" preamble symbols before each payload. </p> <pre> input 1: stream of vectors of gr_complex [fft_length] These are the modulated symbols of the payload.</pre><pre> input 2: stream of char. The LSB indicates whether the corresponding symbol on input 1 is the first symbol of the payload or not. It's a 1 if the corresponding symbol is the first symbol, otherwise 0.</pre><pre> N.B., this implies that there must be at least 1 symbol in the payload.</pre><pre> output 1: stream of vectors of gr_complex [fft_length] These include the preamble symbols and the payload symbols.</pre><pre> output 2: stream of char. The LSB indicates whether the corresponding symbol on input 1 is the first symbol of a packet (i.e., the first symbol of the preamble.) It's a 1 if the corresponding symbol is the first symbol, otherwise 0. </pre><dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">fft_length</td><td>length of each symbol in samples. </td></tr> <tr><td class="paramname">preamble</td><td>vector of symbols that represent the pre-modulated preamble. </td></tr> </table> </dd> </dl> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ad114eb21de28a341f46001727d728fc5"></a><!-- doxytag: member="gr_ofdm_insert_preamble::gr_ofdm_insert_preamble" ref="ad114eb21de28a341f46001727d728fc5" args="(int fft_length, const std::vector< std::vector< gr_complex > > &preamble)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_ofdm_insert_preamble::gr_ofdm_insert_preamble </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>fft_length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > > & </td> <td class="paramname"><em>preamble</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a59263b9b1c692b4f69810bcb94d4351d"></a><!-- doxytag: member="gr_ofdm_insert_preamble::~gr_ofdm_insert_preamble" ref="a59263b9b1c692b4f69810bcb94d4351d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_ofdm_insert_preamble::~gr_ofdm_insert_preamble </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ad79e088f4effd76866d25d6eeafb7ef8"></a><!-- doxytag: member="gr_ofdm_insert_preamble::general_work" ref="ad79e088f4effd76866d25d6eeafb7ef8" args="(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int gr_ofdm_insert_preamble::general_work </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>noutput_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_int</a> & </td> <td class="paramname"><em>ninput_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td> <td class="paramname"><em>input_items</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td> <td class="paramname"><em>output_items</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>compute output items from input items </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">noutput_items</td><td>number of output items to write on each output stream </td></tr> <tr><td class="paramname">ninput_items</td><td>number of input items available on each input stream </td></tr> <tr><td class="paramname">input_items</td><td>vector of pointers to the input items, one entry per input stream </td></tr> <tr><td class="paramname">output_items</td><td>vector of pointers to the output items, one entry per output stream</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items</dd></dl> <p>general_work must call consume or consume_each to indicate how many items were consumed on each input stream. </p> <p>Implements <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">gr_block</a>.</p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a978133681920731a247d286fb078f796"></a><!-- doxytag: member="gr_ofdm_insert_preamble::gr_make_ofdm_insert_preamble" ref="a978133681920731a247d286fb078f796" args="(int fft_length, const std::vector< std::vector< gr_complex > > &preamble)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_ofdm_insert_preamble_sptr</a> gr_make_ofdm_insert_preamble </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>fft_length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="classstd_1_1vector.html">std::vector</a>< <a class="el" href="gr__complex_8h.html#aec4bfe41433369afae9327f1b0bc9109">gr_complex</a> > > & </td> <td class="paramname"><em>preamble</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gr__ofdm__insert__preamble_8h_source.html">gr_ofdm_insert_preamble.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classgr__ofdm__insert__preamble.html">gr_ofdm_insert_preamble</a> </li> <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by  <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>