<!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_block_detail 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_block_detail Class Reference<br/>
<small>
[<a class="el" href="group__internal.html">Implementation Details</a>]</small>
</h1><!-- doxytag: class="gr_block_detail" -->
<p>Implementation details to support the signal processing abstractionThis class contains implementation detail that should be "out of sight" of almost all users of GNU Radio. This decoupling also means that we can make changes to the guts without having to recompile everything.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__block__detail_8h_source.html">gr_block_detail.h</a>></code></p>
<p><a href="classgr__block__detail-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#aad10532c28f1f05eedd255a19491ee5d">~gr_block_detail</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#ad1300802d4b155db9bc18c4de1d5b0bb">ninputs</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#a30c29908303085faa900fbfb5ecd6be9">noutputs</a> () const </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__detail.html#a41cb4924ef6afd5fe0991d76a662bb8a">sink_p</a> () const </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__detail.html#a693f8362d86438e89cc8d21e1141bad5">source_p</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__detail.html#a6ad7846198daf7fafcda8171133df13a">set_done</a> (<a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> done)</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__detail.html#ac05a5d579fd9de0c75dd0ae100657c16">done</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__detail.html#a692bb63708add5fb733fb30dda93d19a">set_input</a> (unsigned int which, <a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> reader)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#a196cb83893cdbb854c4bd2c8079e90ab">input</a> (unsigned int which)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#a84ec68a2d3fda165759b3c78ca1995cf">set_output</a> (unsigned int which, <a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> buffer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#ac885fdb609e98ee74c896b3252294dd0">output</a> (unsigned int which)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#aec7780fbf22b77b35b395283c42d515b">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="#aec7780fbf22b77b35b395283c42d515b"></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__detail.html#a2b3531f63ebfac4b8f75a7918c5120d7">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="#a2b3531f63ebfac4b8f75a7918c5120d7"></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__detail.html#aa328c0933dc5c0052cfa9c4f8520c75b">produce</a> (int which_output, int how_many_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the scheduler <code>how_many_items</code> were produced on output stream <code>which_output</code>. <a href="#aa328c0933dc5c0052cfa9c4f8520c75b"></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__detail.html#a4e15a448fd12bc91163e6240aec1b397">produce_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 produced on each output stream. <a href="#a4e15a448fd12bc91163e6240aec1b397"></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__detail.html#a75ac602d60831c167ff95922e28c93b4">_post</a> (pmt::pmt_t msg)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgr__tpb__detail.html">gr_tpb_detail</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#abf03f4ed4a698a1f4506548a3617afe0">d_tpb</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#a1c722cb66678bcc5b5d9a5a5599c0e19">d_produce_or</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__block__detail.html#a08e853960a2227e07d564d79abd7b212">gr_tpb_detail</a></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__detail.html#a8daad9764ecf402cc18f31392bbf3636">gr_make_block_detail</a> (unsigned int ninputs, unsigned int noutputs)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Implementation details to support the signal processing abstraction</p>
<p>This class contains implementation detail that should be "out of sight" of almost all users of GNU Radio. This decoupling also means that we can make changes to the guts without having to recompile everything. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aad10532c28f1f05eedd255a19491ee5d"></a><!-- doxytag: member="gr_block_detail::~gr_block_detail" ref="aad10532c28f1f05eedd255a19491ee5d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_block_detail::~gr_block_detail </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="a75ac602d60831c167ff95922e28c93b4"></a><!-- doxytag: member="gr_block_detail::_post" ref="a75ac602d60831c167ff95922e28c93b4" args="(pmt::pmt_t msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::_post </td>
<td>(</td>
<td class="paramtype">pmt::pmt_t </td>
<td class="paramname"> <em>msg</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept msg, place in queue, arrange for thread to be awakened if it's not already. </p>
</div>
</div>
<a class="anchor" id="aec7780fbf22b77b35b395283c42d515b"></a><!-- doxytag: member="gr_block_detail::consume" ref="aec7780fbf22b77b35b395283c42d515b" args="(int which_input, int how_many_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::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><td> </td>
</tr>
<tr>
<td></td>
<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="a2b3531f63ebfac4b8f75a7918c5120d7"></a><!-- doxytag: member="gr_block_detail::consume_each" ref="a2b3531f63ebfac4b8f75a7918c5120d7" args="(int how_many_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::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="ac05a5d579fd9de0c75dd0ae100657c16"></a><!-- doxytag: member="gr_block_detail::done" ref="ac05a5d579fd9de0c75dd0ae100657c16" 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_detail::done </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="a196cb83893cdbb854c4bd2c8079e90ab"></a><!-- doxytag: member="gr_block_detail::input" ref="a196cb83893cdbb854c4bd2c8079e90ab" args="(unsigned int which)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> gr_block_detail::input </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>which</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad1300802d4b155db9bc18c4de1d5b0bb"></a><!-- doxytag: member="gr_block_detail::ninputs" ref="ad1300802d4b155db9bc18c4de1d5b0bb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_block_detail::ninputs </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="a30c29908303085faa900fbfb5ecd6be9"></a><!-- doxytag: member="gr_block_detail::noutputs" ref="a30c29908303085faa900fbfb5ecd6be9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_block_detail::noutputs </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="ac885fdb609e98ee74c896b3252294dd0"></a><!-- doxytag: member="gr_block_detail::output" ref="ac885fdb609e98ee74c896b3252294dd0" args="(unsigned int which)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> gr_block_detail::output </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>which</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa328c0933dc5c0052cfa9c4f8520c75b"></a><!-- doxytag: member="gr_block_detail::produce" ref="aa328c0933dc5c0052cfa9c4f8520c75b" args="(int which_output, int how_many_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::produce </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>which_output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>how_many_items</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell the scheduler <code>how_many_items</code> were produced on output stream <code>which_output</code>. </p>
</div>
</div>
<a class="anchor" id="a4e15a448fd12bc91163e6240aec1b397"></a><!-- doxytag: member="gr_block_detail::produce_each" ref="a4e15a448fd12bc91163e6240aec1b397" args="(int how_many_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::produce_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 produced on each output stream. </p>
</div>
</div>
<a class="anchor" id="a6ad7846198daf7fafcda8171133df13a"></a><!-- doxytag: member="gr_block_detail::set_done" ref="a6ad7846198daf7fafcda8171133df13a" args="(bool done)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::set_done </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>done</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a692bb63708add5fb733fb30dda93d19a"></a><!-- doxytag: member="gr_block_detail::set_input" ref="a692bb63708add5fb733fb30dda93d19a" args="(unsigned int which, gr_buffer_reader_sptr reader)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::set_input </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>which</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> </td>
<td class="paramname"> <em>reader</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a84ec68a2d3fda165759b3c78ca1995cf"></a><!-- doxytag: member="gr_block_detail::set_output" ref="a84ec68a2d3fda165759b3c78ca1995cf" args="(unsigned int which, gr_buffer_sptr buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_block_detail::set_output </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>which</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> </td>
<td class="paramname"> <em>buffer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a41cb4924ef6afd5fe0991d76a662bb8a"></a><!-- doxytag: member="gr_block_detail::sink_p" ref="a41cb4924ef6afd5fe0991d76a662bb8a" 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_detail::sink_p </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="a693f8362d86438e89cc8d21e1141bad5"></a><!-- doxytag: member="gr_block_detail::source_p" ref="a693f8362d86438e89cc8d21e1141bad5" 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_detail::source_p </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a8daad9764ecf402cc18f31392bbf3636"></a><!-- doxytag: member="gr_block_detail::gr_make_block_detail" ref="a8daad9764ecf402cc18f31392bbf3636" args="(unsigned int ninputs, unsigned int noutputs)" -->
<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_make_block_detail </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>ninputs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>noutputs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a08e853960a2227e07d564d79abd7b212"></a><!-- doxytag: member="gr_block_detail::gr_tpb_detail" ref="a08e853960a2227e07d564d79abd7b212" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="structgr__tpb__detail.html">gr_tpb_detail</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1c722cb66678bcc5b5d9a5a5599c0e19"></a><!-- doxytag: member="gr_block_detail::d_produce_or" ref="a1c722cb66678bcc5b5d9a5a5599c0e19" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classgr__block__detail.html#a1c722cb66678bcc5b5d9a5a5599c0e19">gr_block_detail::d_produce_or</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abf03f4ed4a698a1f4506548a3617afe0"></a><!-- doxytag: member="gr_block_detail::d_tpb" ref="abf03f4ed4a698a1f4506548a3617afe0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgr__tpb__detail.html">gr_tpb_detail</a> <a class="el" href="classgr__block__detail.html#abf03f4ed4a698a1f4506548a3617afe0">gr_block_detail::d_tpb</a></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__block__detail_8h_source.html">gr_block_detail.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
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
