<!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_block 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__block.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> </div>
<div class="headertitle">
<h1>gr_block Class Reference<div class="ingroups"><a class="el" href="group__base__blk.html">Base classes for GR Blocks</a></div></h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_block" --><!-- doxytag: inherits="gr_basic_block" -->
<p>The abstract base class for all 'terminal' processing blocks.A signal processing flow is constructed by creating a tree of hierarchical blocks, which at any level may also contain terminal nodes that actually implement signal processing functions. This is the base class for all such leaf nodes.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__block_8h_source.html">gr_block.h</a>></code></p>
<p>Inherits <a class="el" href="classgr__basic__block.html">gr_basic_block</a>.</p>
<p>Inherited by <a class="el" href="classgr__align__on__samplenumbers__ss.html">gr_align_on_samplenumbers_ss</a>, <a class="el" href="classgr__clock__recovery__mm__cc.html">gr_clock_recovery_mm_cc</a>, <a class="el" href="classgr__clock__recovery__mm__ff.html">gr_clock_recovery_mm_ff</a>, <a class="el" href="classgr__dd__mpsk__sync__cc.html">gr_dd_mpsk_sync_cc</a>, <a class="el" href="classgr__fractional__interpolator__cc.html">gr_fractional_interpolator_cc</a>, <a class="el" href="classgr__fractional__interpolator__ff.html">gr_fractional_interpolator_ff</a>, <a class="el" href="classgr__keep__one__in__n.html">gr_keep_one_in_n</a>, <a class="el" href="classgr__mpsk__receiver__cc.html">gr_mpsk_receiver_cc</a>, <a class="el" href="classgr__nop.html">gr_nop</a>, <a class="el" href="classgr__ofdm__frame__acquisition.html">gr_ofdm_frame_acquisition</a>, <a class="el" href="classgr__ofdm__insert__preamble.html">gr_ofdm_insert_preamble</a>, <a class="el" href="classgr__ofdm__sampler.html">gr_ofdm_sampler</a>, <a class="el" href="classgr__packed__to__unpacked__bb.html">gr_packed_to_unpacked_bb</a>, <a class="el" href="classgr__packed__to__unpacked__ii.html">gr_packed_to_unpacked_ii</a>, <a class="el" href="classgr__packed__to__unpacked__ss.html">gr_packed_to_unpacked_ss</a>, <a class="el" href="classgr__rational__resampler__base__ccc.html">gr_rational_resampler_base_ccc</a>, <a class="el" href="classgr__rational__resampler__base__ccf.html">gr_rational_resampler_base_ccf</a>, <a class="el" href="classgr__rational__resampler__base__fcc.html">gr_rational_resampler_base_fcc</a>, <a class="el" href="classgr__rational__resampler__base__fff.html">gr_rational_resampler_base_fff</a>, <a class="el" href="classgr__rational__resampler__base__fsf.html">gr_rational_resampler_base_fsf</a>, <a class="el" href="classgr__rational__resampler__base__scc.html">gr_rational_resampler_base_scc</a>, <a class="el" href="classgr__simple__correlator.html">gr_simple_correlator</a>, <a class="el" href="classgr__simple__framer.html">gr_simple_framer</a>, <a class="el" href="classgr__skiphead.html">gr_skiphead</a>, <a class="el" href="classgr__squelch__base__cc.html">gr_squelch_base_cc</a>, <a class="el" href="classgr__squelch__base__ff.html">gr_squelch_base_ff</a>, <a class="el" href="classgr__stream__mux.html">gr_stream_mux</a>, <a class="el" href="classgr__sync__block.html">gr_sync_block</a>, <a class="el" href="classgr__test.html">gr_test</a>, <a class="el" href="classgr__unpacked__to__packed__bb.html">gr_unpacked_to_packed_bb</a>, <a class="el" href="classgr__unpacked__to__packed__ii.html">gr_unpacked_to_packed_ii</a>, <a class="el" href="classgr__unpacked__to__packed__ss.html">gr_unpacked_to_packed_ss</a>, <a class="el" href="classpager__flex__sync.html">pager_flex_sync</a>, <a class="el" href="classtrellis__metrics__c.html">trellis_metrics_c</a>, <a class="el" href="classtrellis__metrics__f.html">trellis_metrics_f</a>, <a class="el" href="classtrellis__metrics__i.html">trellis_metrics_i</a>, <a class="el" href="classtrellis__metrics__s.html">trellis_metrics_s</a>, <a class="el" href="classtrellis__siso__combined__f.html">trellis_siso_combined_f</a>, <a class="el" href="classtrellis__siso__f.html">trellis_siso_f</a>, <a class="el" href="classtrellis__viterbi__b.html">trellis_viterbi_b</a>, <a class="el" href="classtrellis__viterbi__combined__cb.html">trellis_viterbi_combined_cb</a>, <a class="el" href="classtrellis__viterbi__combined__ci.html">trellis_viterbi_combined_ci</a>, <a class="el" href="classtrellis__viterbi__combined__cs.html">trellis_viterbi_combined_cs</a>, <a class="el" href="classtrellis__viterbi__combined__fb.html">trellis_viterbi_combined_fb</a>, <a class="el" href="classtrellis__viterbi__combined__fi.html">trellis_viterbi_combined_fi</a>, <a class="el" href="classtrellis__viterbi__combined__fs.html">trellis_viterbi_combined_fs</a>, <a class="el" href="classtrellis__viterbi__combined__ib.html">trellis_viterbi_combined_ib</a>, <a class="el" href="classtrellis__viterbi__combined__ii.html">trellis_viterbi_combined_ii</a>, <a class="el" href="classtrellis__viterbi__combined__is.html">trellis_viterbi_combined_is</a>, <a class="el" href="classtrellis__viterbi__combined__sb.html">trellis_viterbi_combined_sb</a>, <a class="el" href="classtrellis__viterbi__combined__si.html">trellis_viterbi_combined_si</a>, <a class="el" href="classtrellis__viterbi__combined__ss.html">trellis_viterbi_combined_ss</a>, <a class="el" href="classtrellis__viterbi__i.html">trellis_viterbi_i</a>, and <a class="el" href="classtrellis__viterbi__s.html">trellis_viterbi_s</a>.</p>
<p><a href="classgr__block-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a19133eeffa5f8e6743342f375551ad0c">~gr_block</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ad3b305a663f4b5b5c4e17070d00f05d9">history</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a7c1c85a2d47f72255efd821a6f98f7ba">set_history</a> (unsigned history)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ab4eeb29440f674815ab3b44b4fb0c34d">fixed_rate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return true if this block has a fixed input to output rate <a href="#ab4eeb29440f674815ab3b44b4fb0c34d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#aa1f2518b5c97126bb015adb9e2027f4a">forecast</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_int</a> &ninput_items_required)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Estimate input requirements given output request. <a href="#aa1f2518b5c97126bb015adb9e2027f4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197">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)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compute output items from input items <a href="#a137b93d87dc83bbdb6369d33f4ea8197"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a49ea94a86f3199f23563bb837633ea1f">start</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to enable drivers, etc for i/o devices. <a href="#a49ea94a86f3199f23563bb837633ea1f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a53c2c89c037e4e393b75414d605e36b1">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to disable drivers, etc for i/o devices. <a href="#a53c2c89c037e4e393b75414d605e36b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a14e8b799f920e52afb93fac413b1a729">set_output_multiple</a> (int multiple)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constrain the noutput_items argument passed to forecast and general_work. <a href="#a14e8b799f920e52afb93fac413b1a729"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ade8590e9cba9ccfe1b870be46b1416c2">output_multiple</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ac76b4c53af762a819bca003d5b5cb4d1">consume</a> (int which_input, int how_many_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the scheduler <code>how_many_items</code> of input stream <code>which_input</code> were consumed. <a href="#ac76b4c53af762a819bca003d5b5cb4d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a64e9a2096975841b72ff3c1662d27df9">consume_each</a> (int how_many_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the scheduler <code>how_many_items</code> were consumed on each input stream. <a href="#a64e9a2096975841b72ff3c1662d27df9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#ab9dc7e6d30692bbfa65fc7c4eef6fc9d">set_relative_rate</a> (double relative_rate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the approximate output rate / input rate. <a href="#ab9dc7e6d30692bbfa65fc7c4eef6fc9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#aa9df8c4d3fb92bde98900831546f8b97">relative_rate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the approximate output rate / input rate <a href="#aa9df8c4d3fb92bde98900831546f8b97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a4f17bec4407904b31d45f0d8e78c4683">fixed_rate_ninput_to_noutput</a> (int ninput)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. <a href="#a4f17bec4407904b31d45f0d8e78c4683"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a196ae6a4f9a3d0abed3428d2b765a133">fixed_rate_noutput_to_ninput</a> (int noutput)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. <a href="#a196ae6a4f9a3d0abed3428d2b765a133"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_detail_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#afb276858409ac55d62fca1c87d7d4083">detail</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a26b61f2c2ca308c3bde82f01d3e9650b">set_detail</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_block_detail_sptr</a> detail)</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__block.html#a268510acce1f94c0a60c5273f4948641">gr_block</a> (const std::string &name, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> input_signature, <a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> output_signature)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block.html#a176a95343488a9a760c8edf8bb08db20">set_fixed_rate</a> (<a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> fixed_rate)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The abstract base class for all 'terminal' processing blocks.</p>
<p>A signal processing flow is constructed by creating a tree of hierarchical blocks, which at any level may also contain terminal nodes that actually implement signal processing functions. This is the base class for all such leaf nodes. </p>
<p>Blocks have a set of input streams and output streams. The input_signature and output_signature define the number of input streams and output streams respectively, and the type of the data items in each stream.</p>
<p>Although blocks may consume data on each input stream at a different rate, all outputs streams must produce data at the same rate. That rate may be different from any of the input rates.</p>
<p>User derived blocks override two methods, forecast and general_work, to implement their signal processing behavior. forecast is called by the system scheduler to determine how many items are required on each input stream in order to produce a given number of output items.</p>
<p>general_work is called to perform the signal processing in the block. It reads the input items and writes the output items. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a19133eeffa5f8e6743342f375551ad0c"></a><!-- doxytag: member="gr_block::~gr_block" ref="a19133eeffa5f8e6743342f375551ad0c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_block::~gr_block </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a268510acce1f94c0a60c5273f4948641"></a><!-- doxytag: member="gr_block::gr_block" ref="a268510acce1f94c0a60c5273f4948641" args="(const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_block::gr_block </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> </td>
<td class="paramname"><em>input_signature</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> </td>
<td class="paramname"><em>output_signature</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac76b4c53af762a819bca003d5b5cb4d1"></a><!-- doxytag: member="gr_block::consume" ref="ac76b4c53af762a819bca003d5b5cb4d1" args="(int which_input, int how_many_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block::consume </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>which_input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>how_many_items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell the scheduler <code>how_many_items</code> of input stream <code>which_input</code> were consumed. </p>
</div>
</div>
<a class="anchor" id="a64e9a2096975841b72ff3c1662d27df9"></a><!-- doxytag: member="gr_block::consume_each" ref="a64e9a2096975841b72ff3c1662d27df9" args="(int how_many_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block::consume_each </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>how_many_items</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell the scheduler <code>how_many_items</code> were consumed on each input stream. </p>
</div>
</div>
<a class="anchor" id="afb276858409ac55d62fca1c87d7d4083"></a><!-- doxytag: member="gr_block::detail" ref="afb276858409ac55d62fca1c87d7d4083" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_detail_sptr</a> gr_block::detail </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classgr__block.html#a26b61f2c2ca308c3bde82f01d3e9650b">set_detail()</a>.</p>
</div>
</div>
<a class="anchor" id="ab4eeb29440f674815ab3b44b4fb0c34d"></a><!-- doxytag: member="gr_block::fixed_rate" ref="ab4eeb29440f674815ab3b44b4fb0c34d" args="() const " -->
<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_block::fixed_rate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return true if this block has a fixed input to output rate </p>
<p>If true, then fixed_rate_in_to_out and fixed_rate_out_to_in may be called. </p>
<p>Referenced by <a class="el" href="classgr__block.html#a176a95343488a9a760c8edf8bb08db20">set_fixed_rate()</a>.</p>
</div>
</div>
<a class="anchor" id="a4f17bec4407904b31d45f0d8e78c4683"></a><!-- doxytag: member="gr_block::fixed_rate_ninput_to_noutput" ref="a4f17bec4407904b31d45f0d8e78c4683" args="(int ninput)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gr_block::fixed_rate_ninput_to_noutput </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>ninput</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. </p>
<p>Reimplemented in <a class="el" href="classgr__test.html#abd560ba788790b052bcdf55c40fe203b">gr_test</a>, <a class="el" href="classgr__sync__block.html#a0cbbc0ce275498411248e678038710b2">gr_sync_block</a>, <a class="el" href="classgr__sync__decimator.html#a23c657d3c3f0482369648e1916751f6f">gr_sync_decimator</a>, and <a class="el" href="classgr__sync__interpolator.html#a943227c6134e71a7867a66977b414533">gr_sync_interpolator</a>.</p>
</div>
</div>
<a class="anchor" id="a196ae6a4f9a3d0abed3428d2b765a133"></a><!-- doxytag: member="gr_block::fixed_rate_noutput_to_ninput" ref="a196ae6a4f9a3d0abed3428d2b765a133" args="(int noutput)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gr_block::fixed_rate_noutput_to_ninput </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>noutput</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. </p>
<p>Reimplemented in <a class="el" href="classgr__test.html#abb33a7036cbb39bcfeacf22c6352b50b">gr_test</a>, <a class="el" href="classgr__sync__block.html#adaecb00ae09408c22e46c44d09aad53e">gr_sync_block</a>, <a class="el" href="classgr__sync__decimator.html#a90041d67e72c64cb4d0f9a29bfbbd776">gr_sync_decimator</a>, and <a class="el" href="classgr__sync__interpolator.html#a03961e37cf520668a87f53762e638b9f">gr_sync_interpolator</a>.</p>
</div>
</div>
<a class="anchor" id="aa1f2518b5c97126bb015adb9e2027f4a"></a><!-- doxytag: member="gr_block::forecast" ref="aa1f2518b5c97126bb015adb9e2027f4a" args="(int noutput_items, gr_vector_int &ninput_items_required)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_block::forecast </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_required</em> </td>
</tr>
<tr>
<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 class="params">
<tr><td class="paramname">noutput_items</td><td>number of output items to produce </td></tr>
<tr><td class="paramname">ninput_items_required</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 in <a class="el" href="classgr__fractional__interpolator__cc.html#a570e5166c62a42c1731275ca202c14af">gr_fractional_interpolator_cc</a>, <a class="el" href="classgr__fractional__interpolator__ff.html#a482bc9dcf50f557e5d013456b41e359a">gr_fractional_interpolator_ff</a>, <a class="el" href="classgr__rational__resampler__base__ccc.html#af2fea7c396f5bdfe500dc89dc040ed91">gr_rational_resampler_base_ccc</a>, <a class="el" href="classgr__rational__resampler__base__ccf.html#ad89e5365b4621d883e869f0ca8cea8bb">gr_rational_resampler_base_ccf</a>, <a class="el" href="classgr__rational__resampler__base__fcc.html#a4fb60c5aba43f319edcc084a1cbdf946">gr_rational_resampler_base_fcc</a>, <a class="el" href="classgr__rational__resampler__base__fff.html#af847541f01c596484aae869742c368c6">gr_rational_resampler_base_fff</a>, <a class="el" href="classgr__rational__resampler__base__fsf.html#adad86f397296040fac2c95ed24aba96b">gr_rational_resampler_base_fsf</a>, <a class="el" href="classgr__rational__resampler__base__scc.html#a74b90a1785e0e1bca29b761e03b765f0">gr_rational_resampler_base_scc</a>, <a class="el" href="classgr__align__on__samplenumbers__ss.html#a0ae31942c98cd81ab111d9f1c6d6f194">gr_align_on_samplenumbers_ss</a>, <a class="el" href="classgr__clock__recovery__mm__cc.html#a1e8163d25765d1a34a0b1e06b067781a">gr_clock_recovery_mm_cc</a>, <a class="el" href="classgr__clock__recovery__mm__ff.html#ac56914de0d3761f739feda64958b62d8">gr_clock_recovery_mm_ff</a>, <a class="el" href="classgr__dd__mpsk__sync__cc.html#ac66825ce2aa809b67d115230be6b5d1c">gr_dd_mpsk_sync_cc</a>, <a class="el" href="classgr__mpsk__receiver__cc.html#acfde40e3149cdf0981b00ec7fd8b6109">gr_mpsk_receiver_cc</a>, <a class="el" href="classgr__ofdm__sampler.html#a368b977a7d33e71b8298ff3194627f41">gr_ofdm_sampler</a>, <a class="el" href="classgr__simple__framer.html#a0748fa00c41654ec1f3b6b2a7647555a">gr_simple_framer</a>, <a class="el" href="classgr__stream__mux.html#aae4b1c50e42e75a5c5a9d6f9e185ff84">gr_stream_mux</a>, <a class="el" href="classgr__test.html#a066f8bfd35652cf2f9394bee8e61dc50">gr_test</a>, <a class="el" href="classgr__packed__to__unpacked__bb.html#a911b82f5e94c2eba07967cd37fb8536d">gr_packed_to_unpacked_bb</a>, <a class="el" href="classgr__packed__to__unpacked__ii.html#a3917d044c19552ffdf29ae247b568761">gr_packed_to_unpacked_ii</a>, <a class="el" href="classgr__packed__to__unpacked__ss.html#adfa131f8fab79ded3d50ceaa4ad09274">gr_packed_to_unpacked_ss</a>, <a class="el" href="classgr__unpacked__to__packed__bb.html#aa2d90c18be38f8475df804e3b8e9ff13">gr_unpacked_to_packed_bb</a>, <a class="el" href="classgr__unpacked__to__packed__ii.html#adfe930bf45931874dce9e385a2a0656a">gr_unpacked_to_packed_ii</a>, <a class="el" href="classgr__unpacked__to__packed__ss.html#a41b92b9d89191d5d0147bff38558fc94">gr_unpacked_to_packed_ss</a>, <a class="el" href="classgr__sync__block.html#a1327e83509baf039aa3c816ea81a8f22">gr_sync_block</a>, <a class="el" href="classgr__sync__decimator.html#a140792c0a9777b6b82eb220cdd424ecd">gr_sync_decimator</a>, <a class="el" href="classgr__sync__interpolator.html#a81ef017ef4ec17d0808cd1c0e2ceb803">gr_sync_interpolator</a>, <a class="el" href="classpager__flex__sync.html#a0276435cb29d29f3e6cddc7d97935ed1">pager_flex_sync</a>, <a class="el" href="classtrellis__metrics__c.html#a4400a3c585522d66666e9024130359d5">trellis_metrics_c</a>, <a class="el" href="classtrellis__metrics__f.html#a6bf59f54ce3092e8ae0049936b0044ff">trellis_metrics_f</a>, <a class="el" href="classtrellis__metrics__i.html#ac80d52cfd2a1b31960d216daa35a3b85">trellis_metrics_i</a>, <a class="el" href="classtrellis__metrics__s.html#a5c706cd878ad206558b2e4b1e9954827">trellis_metrics_s</a>, <a class="el" href="classtrellis__siso__combined__f.html#a08dbcd3d99978cfbc30b892b65031d9d">trellis_siso_combined_f</a>, <a class="el" href="classtrellis__siso__f.html#aa5366683a88d6a1394e59cf6312ac911">trellis_siso_f</a>, <a class="el" href="classtrellis__viterbi__b.html#a6a5b3739c0068d3ea015cadb3c1844a6">trellis_viterbi_b</a>, <a class="el" href="classtrellis__viterbi__combined__cb.html#a4fe4530cf7931e1d2b9c97674c68d48b">trellis_viterbi_combined_cb</a>, <a class="el" href="classtrellis__viterbi__combined__ci.html#abdec9b8549aece03f2e70239e31d1af0">trellis_viterbi_combined_ci</a>, <a class="el" href="classtrellis__viterbi__combined__cs.html#a459ee45050460a20825e57f62ea12fdf">trellis_viterbi_combined_cs</a>, <a class="el" href="classtrellis__viterbi__combined__fb.html#a1b34aba0650144ccdd766dbd0c5311d2">trellis_viterbi_combined_fb</a>, <a class="el" href="classtrellis__viterbi__combined__fi.html#a69df50c2fa11d7c849ddfea6d78b2029">trellis_viterbi_combined_fi</a>, <a class="el" href="classtrellis__viterbi__combined__fs.html#a2c1b57036712fdbfb17438803a243934">trellis_viterbi_combined_fs</a>, <a class="el" href="classtrellis__viterbi__combined__ib.html#a9094db736f412b6cd9afa26587ee8fff">trellis_viterbi_combined_ib</a>, <a class="el" href="classtrellis__viterbi__combined__ii.html#a3241a2d6de6f2aaa8f6d9147c7cc0f03">trellis_viterbi_combined_ii</a>, <a class="el" href="classtrellis__viterbi__combined__is.html#a751c39223af7d215b4a7d9772807637f">trellis_viterbi_combined_is</a>, <a class="el" href="classtrellis__viterbi__combined__sb.html#a6ea8c19edd7ee458553d2f66c1e69d25">trellis_viterbi_combined_sb</a>, <a class="el" href="classtrellis__viterbi__combined__si.html#abb36b79e131ca133df58261a4e06128b">trellis_viterbi_combined_si</a>, <a class="el" href="classtrellis__viterbi__combined__ss.html#a912abdce113d1c21b1614801ae63e594">trellis_viterbi_combined_ss</a>, <a class="el" href="classtrellis__viterbi__i.html#a6ce75d28039f254a7845a81cba4e1b0e">trellis_viterbi_i</a>, and <a class="el" href="classtrellis__viterbi__s.html#add9e0582f78c46c74217f4997e930c58">trellis_viterbi_s</a>.</p>
</div>
</div>
<a class="anchor" id="a137b93d87dc83bbdb6369d33f4ea8197"></a><!-- doxytag: member="gr_block::general_work" ref="a137b93d87dc83bbdb6369d33f4ea8197" args="(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gr_block::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> [pure 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>Implemented in <a class="el" href="classgr__fractional__interpolator__cc.html#a66b23b58a645dd89409d69c6d47bfab8">gr_fractional_interpolator_cc</a>, <a class="el" href="classgr__fractional__interpolator__ff.html#a54f3ca4e66e39196420affa96d12dbe3">gr_fractional_interpolator_ff</a>, <a class="el" href="classgr__rational__resampler__base__ccc.html#aedcb25f74e6c511615537ce0a924dd3a">gr_rational_resampler_base_ccc</a>, <a class="el" href="classgr__rational__resampler__base__ccf.html#a8e935e9f3a46bdf93da28c66b0a46bc9">gr_rational_resampler_base_ccf</a>, <a class="el" href="classgr__rational__resampler__base__fcc.html#a0fb2370891c87d44038084dfb74b2283">gr_rational_resampler_base_fcc</a>, <a class="el" href="classgr__rational__resampler__base__fff.html#a93f8b04731192e9b869119d3bc4335cf">gr_rational_resampler_base_fff</a>, <a class="el" href="classgr__rational__resampler__base__fsf.html#a8f9c3bf7971a49c08bd8956671ba90f5">gr_rational_resampler_base_fsf</a>, <a class="el" href="classgr__rational__resampler__base__scc.html#a8617ee9e139fb990c05a1fafb5346172">gr_rational_resampler_base_scc</a>, <a class="el" href="classgr__align__on__samplenumbers__ss.html#abb17a646f937035331c48072b7ca5ee3">gr_align_on_samplenumbers_ss</a>, <a class="el" href="classgr__clock__recovery__mm__cc.html#ae069ef90c7b6dd6c6592ae64e0a498b7">gr_clock_recovery_mm_cc</a>, <a class="el" href="classgr__clock__recovery__mm__ff.html#a7e8a022678f89fef38d13aa078230f93">gr_clock_recovery_mm_ff</a>, <a class="el" href="classgr__dd__mpsk__sync__cc.html#a4b2511faef74997cb05af32d352593e8">gr_dd_mpsk_sync_cc</a>, <a class="el" href="classgr__keep__one__in__n.html#ab57aecd5051ea7dfbba9d15a91441acd">gr_keep_one_in_n</a>, <a class="el" href="classgr__mpsk__receiver__cc.html#aaa5dc2c51fc0a558733edfafbf95e4c9">gr_mpsk_receiver_cc</a>, <a class="el" href="classgr__nop.html#a9003d23b0e7a7ec1ab9f83a2a6f63ba1">gr_nop</a>, <a class="el" href="classgr__ofdm__frame__acquisition.html#ac9e7650efc73d2febe2e90a5e1a9fd3f">gr_ofdm_frame_acquisition</a>, <a class="el" href="classgr__ofdm__insert__preamble.html#ad79e088f4effd76866d25d6eeafb7ef8">gr_ofdm_insert_preamble</a>, <a class="el" href="classgr__ofdm__sampler.html#abcaa849499d9bc1ad2727f233e93d3ee">gr_ofdm_sampler</a>, <a class="el" href="classgr__simple__correlator.html#ae1cdc6cc1f7ea276d7e3cdf025acc367">gr_simple_correlator</a>, <a class="el" href="classgr__simple__framer.html#a5cb527b4eb4089610094bc73f07f6907">gr_simple_framer</a>, <a class="el" href="classgr__skiphead.html#a91b916781b405d2982db9aab2e16f868">gr_skiphead</a>, <a class="el" href="classgr__squelch__base__cc.html#a0b4c46b6b18b013fac914094b99e23d3">gr_squelch_base_cc</a>, <a class="el" href="classgr__squelch__base__ff.html#a578e533e62aa8293ae9944d33e1e16f4">gr_squelch_base_ff</a>, <a class="el" href="classgr__stream__mux.html#a9505b30dc6957ad60dc27711573e6835">gr_stream_mux</a>, <a class="el" href="classgr__test.html#a871aa0cd617be4a13e5cb036bdb55cd7">gr_test</a>, <a class="el" href="classgr__packed__to__unpacked__bb.html#ac5f0a6efe70256b688207ea0635008aa">gr_packed_to_unpacked_bb</a>, <a class="el" href="classgr__packed__to__unpacked__ii.html#a645d435dcc21fa3c569533c14fd2e87f">gr_packed_to_unpacked_ii</a>, <a class="el" href="classgr__packed__to__unpacked__ss.html#a91269652815c6ba7df04fc14cf74046c">gr_packed_to_unpacked_ss</a>, <a class="el" href="classgr__unpacked__to__packed__bb.html#a2faa84b6b32eaef18b2d6d11e08e2bb3">gr_unpacked_to_packed_bb</a>, <a class="el" href="classgr__unpacked__to__packed__ii.html#a2d675a54e405b0bef7e5565581b71b79">gr_unpacked_to_packed_ii</a>, <a class="el" href="classgr__unpacked__to__packed__ss.html#a9485d2a34361afee3faee85728a4c815">gr_unpacked_to_packed_ss</a>, <a class="el" href="classgr__sync__block.html#a56ca60b6bc20a3510f71d961891fa81b">gr_sync_block</a>, <a class="el" href="classgr__sync__decimator.html#a3a7d9a6487780922c14cbb76d46a0586">gr_sync_decimator</a>, <a class="el" href="classgr__sync__interpolator.html#a49cd2967b214ead14270d97dab932301">gr_sync_interpolator</a>, <a class="el" href="classpager__flex__sync.html#ae3772cdb03023b695e4ca62df6b8e67d">pager_flex_sync</a>, <a class="el" href="classtrellis__metrics__c.html#aefc019310c8151cab2802d4fe8fc78ef">trellis_metrics_c</a>, <a class="el" href="classtrellis__metrics__f.html#aefb740cfb8d560b60b179efb907d61e6">trellis_metrics_f</a>, <a class="el" href="classtrellis__metrics__i.html#acfa28b3ac7748f9952a8a260b3fc54f8">trellis_metrics_i</a>, <a class="el" href="classtrellis__metrics__s.html#a1ef65e7c68c609f33719b2e912f620fd">trellis_metrics_s</a>, <a class="el" href="classtrellis__siso__combined__f.html#a0b1d503a66ac2dfd4e0a2a33b43206b1">trellis_siso_combined_f</a>, <a class="el" href="classtrellis__siso__f.html#a1312072636318076e83af3172dcb3bb0">trellis_siso_f</a>, <a class="el" href="classtrellis__viterbi__b.html#a624fe87f46f56b79c3746de387c6a5d4">trellis_viterbi_b</a>, <a class="el" href="classtrellis__viterbi__combined__cb.html#a7ad541af16d67a7e89af19bdc86710d0">trellis_viterbi_combined_cb</a>, <a class="el" href="classtrellis__viterbi__combined__ci.html#a5e8ba444c44ce61f258a365b6098b833">trellis_viterbi_combined_ci</a>, <a class="el" href="classtrellis__viterbi__combined__cs.html#a3ba4e43457c9ecfefd61c753dab56041">trellis_viterbi_combined_cs</a>, <a class="el" href="classtrellis__viterbi__combined__fb.html#a4d6e51c33a0ebb3422bb227e4663ba82">trellis_viterbi_combined_fb</a>, <a class="el" href="classtrellis__viterbi__combined__fi.html#ad8205c461a7b54b693af0751ae7aece2">trellis_viterbi_combined_fi</a>, <a class="el" href="classtrellis__viterbi__combined__fs.html#a1d18b1e09f6fda6848c8d5e0bf9d8ee1">trellis_viterbi_combined_fs</a>, <a class="el" href="classtrellis__viterbi__combined__ib.html#aff426249d523f25f4cd2fd705fda5f38">trellis_viterbi_combined_ib</a>, <a class="el" href="classtrellis__viterbi__combined__ii.html#aae2623dc4042e51a4841e43aba85004d">trellis_viterbi_combined_ii</a>, <a class="el" href="classtrellis__viterbi__combined__is.html#a6eb341dc26a0ff9d229e92c7ebf98a26">trellis_viterbi_combined_is</a>, <a class="el" href="classtrellis__viterbi__combined__sb.html#a8e840f02fd1f39331d4d9b2e21440e5e">trellis_viterbi_combined_sb</a>, <a class="el" href="classtrellis__viterbi__combined__si.html#aa52c420898e1d86d8677cfbd428cc576">trellis_viterbi_combined_si</a>, <a class="el" href="classtrellis__viterbi__combined__ss.html#affc641d2f5c540a7beb6fe0bfc7777b5">trellis_viterbi_combined_ss</a>, <a class="el" href="classtrellis__viterbi__i.html#a32dbed769368f42d0753a066d09fb2e1">trellis_viterbi_i</a>, and <a class="el" href="classtrellis__viterbi__s.html#ab81f0d501b3ab23897447e7a715b7409">trellis_viterbi_s</a>.</p>
</div>
</div>
<a class="anchor" id="ad3b305a663f4b5b5c4e17070d00f05d9"></a><!-- doxytag: member="gr_block::history" ref="ad3b305a663f4b5b5c4e17070d00f05d9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned gr_block::history </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assume block computes y_i = f(x_i, x_i-1, x_i-2, x_i-3...) History is the number of x_i's that are examined to produce one y_i. This comes in handy for FIR filters, where we use history to ensure that our input contains the appropriate "history" for the filter. History should be equal to the number of filter taps. </p>
<p>Reimplemented in <a class="el" href="classgr__rational__resampler__base__ccc.html#a64547bf9d35091e7a6974d1992f6c878">gr_rational_resampler_base_ccc</a>, <a class="el" href="classgr__rational__resampler__base__ccf.html#a39bb26cbf671056d51daa2fa931cfc2d">gr_rational_resampler_base_ccf</a>, <a class="el" href="classgr__rational__resampler__base__fcc.html#a093a9ebd07a175ce954bc789509f3485">gr_rational_resampler_base_fcc</a>, <a class="el" href="classgr__rational__resampler__base__fff.html#a6c6978e86e41cf36ec46f1fd8da58f00">gr_rational_resampler_base_fff</a>, <a class="el" href="classgr__rational__resampler__base__fsf.html#a93eeb305ceabd3044bd3209f674cbeca">gr_rational_resampler_base_fsf</a>, and <a class="el" href="classgr__rational__resampler__base__scc.html#ac6cb6e87c68f83d04864d9de62629993">gr_rational_resampler_base_scc</a>.</p>
<p>Referenced by <a class="el" href="classgr__delay.html#a1b480a7ef7039a053d573bf5cb6d91cd">gr_delay::delay()</a>, <a class="el" href="classgr__test.html#a066f8bfd35652cf2f9394bee8e61dc50">gr_test::forecast()</a>, and <a class="el" href="classgr__block.html#a7c1c85a2d47f72255efd821a6f98f7ba">set_history()</a>.</p>
</div>
</div>
<a class="anchor" id="ade8590e9cba9ccfe1b870be46b1416c2"></a><!-- doxytag: member="gr_block::output_multiple" ref="ade8590e9cba9ccfe1b870be46b1416c2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_block::output_multiple </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa9df8c4d3fb92bde98900831546f8b97"></a><!-- doxytag: member="gr_block::relative_rate" ref="aa9df8c4d3fb92bde98900831546f8b97" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double gr_block::relative_rate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return the approximate output rate / input rate </p>
<p>Referenced by <a class="el" href="classgr__test.html#abd560ba788790b052bcdf55c40fe203b">gr_test::fixed_rate_ninput_to_noutput()</a>, <a class="el" href="classgr__test.html#abb33a7036cbb39bcfeacf22c6352b50b">gr_test::fixed_rate_noutput_to_ninput()</a>, and <a class="el" href="classgr__test.html#a066f8bfd35652cf2f9394bee8e61dc50">gr_test::forecast()</a>.</p>
</div>
</div>
<a class="anchor" id="a26b61f2c2ca308c3bde82f01d3e9650b"></a><!-- doxytag: member="gr_block::set_detail" ref="a26b61f2c2ca308c3bde82f01d3e9650b" args="(gr_block_detail_sptr detail)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block::set_detail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_detail_sptr</a> </td>
<td class="paramname"><em>detail</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__block.html#afb276858409ac55d62fca1c87d7d4083">detail()</a>.</p>
</div>
</div>
<a class="anchor" id="a176a95343488a9a760c8edf8bb08db20"></a><!-- doxytag: member="gr_block::set_fixed_rate" ref="a176a95343488a9a760c8edf8bb08db20" args="(bool fixed_rate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block::set_fixed_rate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"><em>fixed_rate</em></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classgr__block.html#ab4eeb29440f674815ab3b44b4fb0c34d">fixed_rate()</a>.</p>
<p>Referenced by <a class="el" href="classgr__test.html#a7aa4753ba5e757786726f7dd29118199">gr_test::set_fixed_rate_public()</a>.</p>
</div>
</div>
<a class="anchor" id="a7c1c85a2d47f72255efd821a6f98f7ba"></a><!-- doxytag: member="gr_block::set_history" ref="a7c1c85a2d47f72255efd821a6f98f7ba" args="(unsigned history)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block::set_history </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>history</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classgr__rational__resampler__base__ccc.html#a9ebb9ae70178b5f5e824d762a1e7e433">gr_rational_resampler_base_ccc</a>, <a class="el" href="classgr__rational__resampler__base__ccf.html#a0d0e569a85bcb299c43880ce8dd4b75b">gr_rational_resampler_base_ccf</a>, <a class="el" href="classgr__rational__resampler__base__fcc.html#a72dea2e8ad318b3526586a19f94805f2">gr_rational_resampler_base_fcc</a>, <a class="el" href="classgr__rational__resampler__base__fff.html#a105db50c0961705e18244f5e865b957b">gr_rational_resampler_base_fff</a>, <a class="el" href="classgr__rational__resampler__base__fsf.html#a67feadbd12c215ae25a185fe8cfcbae7">gr_rational_resampler_base_fsf</a>, and <a class="el" href="classgr__rational__resampler__base__scc.html#a353a5fe5a3295f1a83349a69a5a52ac8">gr_rational_resampler_base_scc</a>.</p>
<p>References <a class="el" href="classgr__block.html#ad3b305a663f4b5b5c4e17070d00f05d9">history()</a>.</p>
<p>Referenced by <a class="el" href="classgr__delay.html#a2d4928b0b56e292322abddcbac9992a1">gr_delay::set_delay()</a>.</p>
</div>
</div>
<a class="anchor" id="a14e8b799f920e52afb93fac413b1a729"></a><!-- doxytag: member="gr_block::set_output_multiple" ref="a14e8b799f920e52afb93fac413b1a729" args="(int multiple)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block::set_output_multiple </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>multiple</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constrain the noutput_items argument passed to forecast and general_work. </p>
<p>set_output_multiple causes the scheduler to ensure that the noutput_items argument passed to forecast and general_work will be an integer multiple of </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">multiple</td><td>The default value of output multiple is 1. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="classgr__sync__interpolator.html#a25bb02d6ac26404780bdd217355107ad">gr_sync_interpolator::set_interpolation()</a>.</p>
</div>
</div>
<a class="anchor" id="ab9dc7e6d30692bbfa65fc7c4eef6fc9d"></a><!-- doxytag: member="gr_block::set_relative_rate" ref="ab9dc7e6d30692bbfa65fc7c4eef6fc9d" args="(double relative_rate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block::set_relative_rate </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>relative_rate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the approximate output rate / input rate. </p>
<p>Provide a hint to the buffer allocator and scheduler. The default relative_rate is 1.0</p>
<p>decimators have relative_rates < 1.0 interpolators have relative_rates > 1.0 </p>
<p>Referenced by <a class="el" href="classgr__sync__decimator.html#a5ae57c3e625dfaca6487a319c2078a57">gr_sync_decimator::set_decimation()</a>, and <a class="el" href="classgr__sync__interpolator.html#a25bb02d6ac26404780bdd217355107ad">gr_sync_interpolator::set_interpolation()</a>.</p>
</div>
</div>
<a class="anchor" id="a49ea94a86f3199f23563bb837633ea1f"></a><!-- doxytag: member="gr_block::start" ref="a49ea94a86f3199f23563bb837633ea1f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_block::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called to enable drivers, etc for i/o devices. </p>
<p>This allows a block to enable an associated driver to begin transfering data just before we start to execute the scheduler. The end result is that this reduces latency in the pipeline when dealing with audio devices, usrps, etc. </p>
<p>Reimplemented in <a class="el" href="classaudio__osx__sink.html#af4004bd08b0577701983ba0e2029bd48">audio_osx_sink</a>, <a class="el" href="classaudio__osx__source.html#a783cf6498ede9ffb14396b72fffbb731">audio_osx_source</a>, <a class="el" href="classusrp__sink__base.html#a85efc4fe8b2f93f8035a61c793562d74">usrp_sink_base</a>, <a class="el" href="classusrp__source__base.html#a9153e851aed832d42ad878efe0f90cd4">usrp_source_base</a>, <a class="el" href="classusrp2__base.html#acba2abb76b13eaf7be15d787244bdf6b">usrp2_base</a>, and <a class="el" href="classusrp2__source__base.html#a8283ff40606ce6fc239a0cf52a67cfa4">usrp2_source_base</a>.</p>
</div>
</div>
<a class="anchor" id="a53c2c89c037e4e393b75414d605e36b1"></a><!-- doxytag: member="gr_block::stop" ref="a53c2c89c037e4e393b75414d605e36b1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> gr_block::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called to disable drivers, etc for i/o devices. </p>
<p>Reimplemented in <a class="el" href="classaudio__osx__sink.html#af57ebe4d74be578d0357e9a7171eb785">audio_osx_sink</a>, <a class="el" href="classaudio__osx__source.html#a902595b2e1886706ffbca4465ea71e04">audio_osx_source</a>, <a class="el" href="classusrp__sink__base.html#a79a0f7db96a450be5bf86c5ab031d6de">usrp_sink_base</a>, <a class="el" href="classusrp__source__base.html#a8bafa0648c4e3194ac7ecccafdaca49c">usrp_source_base</a>, <a class="el" href="classusrp2__base.html#a7f92359dc1760ac40f201da01886b14f">usrp2_base</a>, and <a class="el" href="classusrp2__source__base.html#adea8505626b80ad87a5ad4092b2a639a">usrp2_source_base</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__block_8h_source.html">gr_block.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__block.html">gr_block</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
703
