Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > by-pkgid > def0228095a1541e2d3632b6b6da7c38 > files > 1231

gnuradio-doc-3.3.0-8mdv2010.1.i586.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.3.0 C++ API: gr_chunks_to_symbols_bf Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="contents">
<h1>gr_chunks_to_symbols_bf Class Reference<br/>
<small>
[<a class="el" href="group__converter__blk.html">Type Conversions</a>]</small>
</h1><!-- doxytag: class="gr_chunks_to_symbols_bf" --><!-- doxytag: inherits="gr_sync_interpolator" -->
<p>Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation points.in <code>D</code> dimensions (<code>D</code> = 1 by default)input: stream of unsigned char; output: stream of float.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="gr__chunks__to__symbols__bf_8h_source.html">gr_chunks_to_symbols_bf.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gr_chunks_to_symbols_bf:</div>
<div class="dynsection">
<div class="center"><img src="classgr__chunks__to__symbols__bf__inherit__graph.png" border="0" usemap="#gr__chunks__to__symbols__bf_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__chunks__to__symbols__bf_inherit__map" id="gr__chunks__to__symbols__bf_inherit__map">
<area shape="rect" id="node2" href="classgr__sync__interpolator.html" title="synchronous 1:N input to output with historyOverride work to provide the signal processing..." alt="" coords="23,392,161,421"/><area shape="rect" id="node4" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="39,315,145,344"/><area shape="rect" id="node6" href="classgr__block.html" title="The abstract base class for all &#39;terminal&#39; processing blocks.A signal processing..." alt="" coords="57,237,127,267"/><area shape="rect" id="node8" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="37,160,147,189"/><area shape="rect" id="node10" href="classgr__msg__accepter.html" title="Accepts messages and inserts them into a message queue, then notifies subclass gr_basic_block..." alt="" coords="31,83,153,112"/><area shape="rect" id="node12" href="classgruel_1_1msg__accepter.html" title="Virtual base class that accepts messages." alt="" coords="23,5,161,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classgr__chunks__to__symbols__bf-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__chunks__to__symbols__bf.html#ad45ffbd73ece32b4c01aa685f6f6b420">D</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; float &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__chunks__to__symbols__bf.html#a4cb39642ef1ac9faabd3d182e421ea3f">symbol_table</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__chunks__to__symbols__bf.html#a736d4e3453c9938222fa9f536f8b39a2">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &amp;input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &amp;output_items)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you  <a href="#a736d4e3453c9938222fa9f536f8b39a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__chunks__to__symbols__bf.html#ae82608cda5b9d05bd0279513bf0d2bcb">check_topology</a> (int ninputs, int noutputs)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Confirm that ninputs and noutputs is an acceptable combination.  <a href="#ae82608cda5b9d05bd0279513bf0d2bcb"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_chunks_to_symbols_bf_sptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__chunks__to__symbols__bf.html#a2e9f842f4d2f5758f28663f840a49a29">gr_make_chunks_to_symbols_bf</a> (const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; float &gt; &amp;symbol_table, const int D)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation points.in <code>D</code> dimensions (<code>D</code> = 1 by default)</p>
<p>input: stream of unsigned char; output: stream of float. </p>
<p>out[n D + k] = symbol_table[in[n] D + k], k=0,1,...,D-1</p>
<p>The combination of gr_packed_to_unpacked_XX followed by gr_chunks_to_symbols_XY handles the general case of mapping from a stream of bytes or shorts into arbitrary float or complex symbols.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgr__packed__to__unpacked__bb.html" title="Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts...">gr_packed_to_unpacked_bb</a>, <a class="el" href="classgr__unpacked__to__packed__bb.html" title="Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts...">gr_unpacked_to_packed_bb</a>, </dd>
<dd>
<a class="el" href="classgr__packed__to__unpacked__ss.html" title="Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts...">gr_packed_to_unpacked_ss</a>, <a class="el" href="classgr__unpacked__to__packed__ss.html" title="Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts...">gr_unpacked_to_packed_ss</a>, </dd>
<dd>
<a class="el" href="classgr__chunks__to__symbols__bf.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_bf</a>, <a class="el" href="classgr__chunks__to__symbols__bc.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_bc</a>. </dd>
<dd>
<a class="el" href="classgr__chunks__to__symbols__sf.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_sf</a>, <a class="el" href="classgr__chunks__to__symbols__sc.html" title="Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex...">gr_chunks_to_symbols_sc</a>. </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae82608cda5b9d05bd0279513bf0d2bcb"></a><!-- doxytag: member="gr_chunks_to_symbols_bf::check_topology" ref="ae82608cda5b9d05bd0279513bf0d2bcb" args="(int ninputs, int noutputs)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_chunks_to_symbols_bf::check_topology </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>ninputs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>noutputs</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Confirm that ninputs and noutputs is an acceptable combination. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ninputs</em>&nbsp;</td><td>number of input streams connected </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>noutputs</em>&nbsp;</td><td>number of output streams connected</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this is a valid configuration for this block.</dd></dl>
<p>This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures. </p>

<p>Reimplemented from <a class="el" href="classgr__basic__block.html#a50a714df9c3ce8c03854a09ac84e589b">gr_basic_block</a>.</p>

</div>
</div>
<a class="anchor" id="ad45ffbd73ece32b4c01aa685f6f6b420"></a><!-- doxytag: member="gr_chunks_to_symbols_bf::D" ref="ad45ffbd73ece32b4c01aa685f6f6b420" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int gr_chunks_to_symbols_bf::D </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a4cb39642ef1ac9faabd3d182e421ea3f"></a><!-- doxytag: member="gr_chunks_to_symbols_bf::symbol_table" ref="a4cb39642ef1ac9faabd3d182e421ea3f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classstd_1_1vector.html">std::vector</a>&lt;float&gt; gr_chunks_to_symbols_bf::symbol_table </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a736d4e3453c9938222fa9f536f8b39a2"></a><!-- doxytag: member="gr_chunks_to_symbols_bf::work" ref="a736d4e3453c9938222fa9f536f8b39a2" args="(int noutput_items, gr_vector_const_void_star &amp;input_items, gr_vector_void_star &amp;output_items)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int gr_chunks_to_symbols_bf::work </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</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_const_void_star</a> &amp;&nbsp;</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> &amp;&nbsp;</td>
          <td class="paramname"> <em>output_items</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p>
<p>The user must override work to define the signal processing code </p>

<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a2e9f842f4d2f5758f28663f840a49a29"></a><!-- doxytag: member="gr_chunks_to_symbols_bf::gr_make_chunks_to_symbols_bf" ref="a2e9f842f4d2f5758f28663f840a49a29" args="(const std::vector&lt; float &gt; &amp;symbol_table, const int D)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_chunks_to_symbols_bf_sptr</a> gr_make_chunks_to_symbols_bf </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>&lt; float &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>symbol_table</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const int&nbsp;</td>
          <td class="paramname"> <em>D</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <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__chunks__to__symbols__bf_8h_source.html">gr_chunks_to_symbols_bf.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:39 2010 for GNU Radio 3.3.0 C++ API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>