Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > media > contrib-backports > by-pkgid > def0228095a1541e2d3632b6b6da7c38 > files > 431

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: atsc_field_sync_mux 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>atsc_field_sync_mux Class Reference<br/>
<small>
[<a class="el" href="group__atsc.html">ATSC</a>]</small>
</h1><!-- doxytag: class="atsc_field_sync_mux" --><!-- doxytag: inherits="gr_sync_block" -->
<p>Insert ATSC Field Syncs as required (<a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a> --&gt; <a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a>)input: <a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a>; output: <a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a>.  
<a href="#_details">More...</a></p>

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

<p><a href="classatsc__field__sync__mux-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classatsc__field__sync__mux.html#a7d1e7b3f5ce562f49e1f5c9634df22c6">forecast</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &amp;ninput_items_required)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Estimate input requirements given output request.  <a href="#a7d1e7b3f5ce562f49e1f5c9634df22c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classatsc__field__sync__mux.html#ae45f7fff73dd59a616ef1d46cc897c41">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="#ae45f7fff73dd59a616ef1d46cc897c41"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classatsc__field__sync__mux.html#adaeb8bb0ec6053666f9c4313b364fad6">reset</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classatsc__field__sync__mux.html#a1793da91f1eced2e6e9aad2ce1140cda">N_SAVED_SYMBOLS</a> = 12</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__types_8h.html#aae33a617adccdf63041e3593a877012c">gr_uint64</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classatsc__field__sync__mux.html#a2d521f3a888763836fb3b848d58431f3">d_current_index</a></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="classatsc__field__sync__mux.html#ab8414f6b2978125970615bd5230161e4">d_already_output_field_sync</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classatsc__field__sync__mux.html#a6f937335cd67ddef985264d01120cc4a">d_saved_symbols</a> [<a class="el" href="classatsc__field__sync__mux.html#a1793da91f1eced2e6e9aad2ce1140cda">N_SAVED_SYMBOLS</a>]</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">atsc_field_sync_mux_sptr</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classatsc__field__sync__mux.html#a8e6b11e32f82f53958213e0b60228f76">atsc_make_field_sync_mux</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Insert ATSC Field Syncs as required (<a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a> --&gt; <a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a>)</p>
<p>input: <a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a>; output: <a class="el" href="classatsc__data__segment.html" title="contains 832 3 bit symbols. The low 3 bits in the byte hold the symbol.">atsc_data_segment</a>. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7d1e7b3f5ce562f49e1f5c9634df22c6"></a><!-- doxytag: member="atsc_field_sync_mux::forecast" ref="a7d1e7b3f5ce562f49e1f5c9634df22c6" args="(int noutput_items, gr_vector_int &amp;ninput_items_required)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void atsc_field_sync_mux::forecast </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_int</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ninput_items_required</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>Estimate input requirements given output request. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>noutput_items</em>&nbsp;</td><td>number of output items to produce </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ninput_items_required</em>&nbsp;</td><td>number of input items required on each input stream</td></tr>
  </table>
  </dd>
</dl>
<p>Given a request to product <code>noutput_items</code>, estimate the number of data items required on each input stream. The estimate doesn't have to be exact, but should be close. </p>

<p>Reimplemented from <a class="el" href="classgr__sync__block.html#a1327e83509baf039aa3c816ea81a8f22">gr_sync_block</a>.</p>

</div>
</div>
<a class="anchor" id="adaeb8bb0ec6053666f9c4313b364fad6"></a><!-- doxytag: member="atsc_field_sync_mux::reset" ref="adaeb8bb0ec6053666f9c4313b364fad6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void atsc_field_sync_mux::reset </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ae45f7fff73dd59a616ef1d46cc897c41"></a><!-- doxytag: member="atsc_field_sync_mux::work" ref="ae45f7fff73dd59a616ef1d46cc897c41" 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 atsc_field_sync_mux::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="a8e6b11e32f82f53958213e0b60228f76"></a><!-- doxytag: member="atsc_field_sync_mux::atsc_make_field_sync_mux" ref="a8e6b11e32f82f53958213e0b60228f76" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">atsc_field_sync_mux_sptr</a> atsc_make_field_sync_mux </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab8414f6b2978125970615bd5230161e4"></a><!-- doxytag: member="atsc_field_sync_mux::d_already_output_field_sync" ref="ab8414f6b2978125970615bd5230161e4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> <a class="el" href="classatsc__field__sync__mux.html#ab8414f6b2978125970615bd5230161e4">atsc_field_sync_mux::d_already_output_field_sync</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a2d521f3a888763836fb3b848d58431f3"></a><!-- doxytag: member="atsc_field_sync_mux::d_current_index" ref="a2d521f3a888763836fb3b848d58431f3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="gr__types_8h.html#aae33a617adccdf63041e3593a877012c">gr_uint64</a> <a class="el" href="classatsc__field__sync__mux.html#a2d521f3a888763836fb3b848d58431f3">atsc_field_sync_mux::d_current_index</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a6f937335cd67ddef985264d01120cc4a"></a><!-- doxytag: member="atsc_field_sync_mux::d_saved_symbols" ref="a6f937335cd67ddef985264d01120cc4a" args="[N_SAVED_SYMBOLS]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char <a class="el" href="classatsc__field__sync__mux.html#a6f937335cd67ddef985264d01120cc4a">atsc_field_sync_mux::d_saved_symbols</a>[<a class="el" href="classatsc__field__sync__mux.html#a1793da91f1eced2e6e9aad2ce1140cda">N_SAVED_SYMBOLS</a>]<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a1793da91f1eced2e6e9aad2ce1140cda"></a><!-- doxytag: member="atsc_field_sync_mux::N_SAVED_SYMBOLS" ref="a1793da91f1eced2e6e9aad2ce1140cda" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const int <a class="el" href="classatsc__field__sync__mux.html#a1793da91f1eced2e6e9aad2ce1140cda">atsc_field_sync_mux::N_SAVED_SYMBOLS</a> = 12<code> [static]</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="atsc__field__sync__mux_8h_source.html">atsc_field_sync_mux.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:30 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>