<!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_detail.h Source File</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('gr__block__detail_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_block_detail.h</h1> </div>
</div>
<div class="contents">
<a href="gr__block__detail_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2004 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more detail.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_BLOCK_DETAIL_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_BLOCK_DETAIL_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <<a class="code" href="gr__runtime__types_8h.html">gr_runtime_types.h</a>></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="gr__tpb__detail_8h.html">gr_tpb_detail.h</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <stdexcept></span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/*!</span>
<a name="l00031"></a>00031 <span class="comment"> * \brief Implementation details to support the signal processing abstraction</span>
<a name="l00032"></a>00032 <span class="comment"> * \ingroup internal</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * This class contains implementation detail that should be "out of sight"</span>
<a name="l00035"></a>00035 <span class="comment"> * of almost all users of GNU Radio. This decoupling also means that</span>
<a name="l00036"></a>00036 <span class="comment"> * we can make changes to the guts without having to recompile everything.</span>
<a name="l00037"></a>00037 <span class="comment"> */</span>
<a name="l00038"></a><a class="code" href="classgr__block__detail.html">00038</a> <span class="keyword">class </span><a class="code" href="classgr__block__detail.html" title="Implementation details to support the signal processing abstractionThis class contains implementation...">gr_block_detail</a> {
<a name="l00039"></a>00039 <span class="keyword">public</span>:
<a name="l00040"></a>00040 <a class="code" href="classgr__block__detail.html#aad10532c28f1f05eedd255a19491ee5d">~gr_block_detail</a> ();
<a name="l00041"></a>00041
<a name="l00042"></a><a class="code" href="classgr__block__detail.html#ad1300802d4b155db9bc18c4de1d5b0bb">00042</a> <span class="keywordtype">int</span> <a class="code" href="classgr__block__detail.html#ad1300802d4b155db9bc18c4de1d5b0bb">ninputs</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_ninputs; }
<a name="l00043"></a><a class="code" href="classgr__block__detail.html#a30c29908303085faa900fbfb5ecd6be9">00043</a> <span class="keywordtype">int</span> <a class="code" href="classgr__block__detail.html#a30c29908303085faa900fbfb5ecd6be9">noutputs</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_noutputs; }
<a name="l00044"></a><a class="code" href="classgr__block__detail.html#a41cb4924ef6afd5fe0991d76a662bb8a">00044</a> <span class="keywordtype">bool</span> <a class="code" href="classgr__block__detail.html#a41cb4924ef6afd5fe0991d76a662bb8a">sink_p</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_noutputs == 0; }
<a name="l00045"></a><a class="code" href="classgr__block__detail.html#a693f8362d86438e89cc8d21e1141bad5">00045</a> <span class="keywordtype">bool</span> <a class="code" href="classgr__block__detail.html#a693f8362d86438e89cc8d21e1141bad5">source_p</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_ninputs == 0; }
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keywordtype">void</span> <a class="code" href="classgr__block__detail.html#a6ad7846198daf7fafcda8171133df13a">set_done</a> (<span class="keywordtype">bool</span> <a class="code" href="classgr__block__detail.html#ac05a5d579fd9de0c75dd0ae100657c16">done</a>);
<a name="l00048"></a><a class="code" href="classgr__block__detail.html#ac05a5d579fd9de0c75dd0ae100657c16">00048</a> <span class="keywordtype">bool</span> <a class="code" href="classgr__block__detail.html#ac05a5d579fd9de0c75dd0ae100657c16">done</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_done; }
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="classgr__block__detail.html#a692bb63708add5fb733fb30dda93d19a">set_input</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> which, <a class="code" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> reader);
<a name="l00051"></a><a class="code" href="classgr__block__detail.html#a196cb83893cdbb854c4bd2c8079e90ab">00051</a> <a class="code" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> <a class="code" href="classgr__block__detail.html#a196cb83893cdbb854c4bd2c8079e90ab">input</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> which)
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keywordflow">if</span> (which >= d_ninputs)
<a name="l00054"></a>00054 <span class="keywordflow">throw</span> std::invalid_argument (<span class="stringliteral">"gr_block_detail::input"</span>);
<a name="l00055"></a>00055 <span class="keywordflow">return</span> d_input[which];
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keywordtype">void</span> <a class="code" href="classgr__block__detail.html#a84ec68a2d3fda165759b3c78ca1995cf">set_output</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> which, <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_buffer_sptr</a> buffer);
<a name="l00059"></a><a class="code" href="classgr__block__detail.html#ac885fdb609e98ee74c896b3252294dd0">00059</a> <a class="code" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> <a class="code" href="classgr__block__detail.html#ac885fdb609e98ee74c896b3252294dd0">output</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> which)
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 <span class="keywordflow">if</span> (which >= d_noutputs)
<a name="l00062"></a>00062 <span class="keywordflow">throw</span> std::invalid_argument (<span class="stringliteral">"gr_block_detail::output"</span>);
<a name="l00063"></a>00063 <span class="keywordflow">return</span> d_output[which];
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065 <span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment"> /*!</span>
<a name="l00067"></a>00067 <span class="comment"> * \brief Tell the scheduler \p how_many_items of input stream \p which_input were consumed.</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="classgr__block__detail.html#aec7780fbf22b77b35b395283c42d515b" title="Tell the scheduler how_many_items of input stream which_input were consumed.">consume</a> (<span class="keywordtype">int</span> which_input, <span class="keywordtype">int</span> how_many_items);
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment"> /*!</span>
<a name="l00072"></a>00072 <span class="comment"> * \brief Tell the scheduler \p how_many_items were consumed on each input stream.</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a>00074 <span class="keywordtype">void</span> <a class="code" href="classgr__block__detail.html#a2b3531f63ebfac4b8f75a7918c5120d7" title="Tell the scheduler how_many_items were consumed on each input stream.">consume_each</a> (<span class="keywordtype">int</span> how_many_items);
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /*!</span>
<a name="l00077"></a>00077 <span class="comment"> * \brief Tell the scheduler \p how_many_items were produced on each output stream.</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="classgr__block__detail.html#a4e15a448fd12bc91163e6240aec1b397" title="Tell the scheduler how_many_items were produced on each output stream.">produce_each</a> (<span class="keywordtype">int</span> how_many_items);
<a name="l00080"></a>00080
<a name="l00081"></a>00081
<a name="l00082"></a><a class="code" href="classgr__block__detail.html#abf03f4ed4a698a1f4506548a3617afe0">00082</a> <a class="code" href="structgr__tpb__detail.html" title="used by thread-per-block scheduler">gr_tpb_detail</a> <a class="code" href="classgr__block__detail.html#abf03f4ed4a698a1f4506548a3617afe0">d_tpb</a>; <span class="comment">// used by thread-per-block scheduler</span>
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keyword">private</span>:
<a name="l00087"></a>00087 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_ninputs;
<a name="l00088"></a>00088 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> d_noutputs;
<a name="l00089"></a>00089 <a class="code" href="classstd_1_1vector.html">std::vector<gr_buffer_reader_sptr></a> d_input;
<a name="l00090"></a>00090 <a class="code" href="classstd_1_1vector.html">std::vector<gr_buffer_sptr></a> d_output;
<a name="l00091"></a>00091 <span class="keywordtype">bool</span> d_done;
<a name="l00092"></a>00092
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <a class="code" href="classgr__block__detail.html" title="Implementation details to support the signal processing abstractionThis class contains implementation...">gr_block_detail</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__block__detail.html#ad1300802d4b155db9bc18c4de1d5b0bb">ninputs</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__block__detail.html#a30c29908303085faa900fbfb5ecd6be9">noutputs</a>);
<a name="l00095"></a>00095
<a name="l00096"></a><a class="code" href="classgr__block__detail.html#a08e853960a2227e07d564d79abd7b212">00096</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="structgr__tpb__detail.html" title="used by thread-per-block scheduler">gr_tpb_detail</a>;
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html">gr_block_detail_sptr</a>
<a name="l00099"></a>00099 <a class="code" href="classgr__block__detail.html#a8daad9764ecf402cc18f31392bbf3636">gr_make_block_detail</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__block__detail.html#ad1300802d4b155db9bc18c4de1d5b0bb">ninputs</a>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classgr__block__detail.html#a30c29908303085faa900fbfb5ecd6be9">noutputs</a>);
<a name="l00100"></a>00100 };
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <a class="code" href="classboost_1_1shared__ptr.html">gr_block_detail_sptr</a>
<a name="l00103"></a>00103 <a class="code" href="gr__block__detail_8h.html#a8daad9764ecf402cc18f31392bbf3636">gr_make_block_detail</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ninputs, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> noutputs);
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keywordtype">long</span>
<a name="l00106"></a>00106 <a class="code" href="gr__block__detail_8h.html#a4739c09853d324866ac4b230d32cd18d">gr_block_detail_ncurrently_allocated</a> ();
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_BLOCK_DETAIL_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__block__detail_8h.html">gr_block_detail.h</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
>
3758
