<!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_hier_block2.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__hier__block2_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_hier_block2.h</h1> </div>
</div>
<div class="contents">
<a href="gr__hier__block2_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 2006,2007,2008,2009 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 details.</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 <span class="preprocessor">#ifndef INCLUDED_GR_HIER_BLOCK2_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_HIER_BLOCK2_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <<a class="code" href="gr__basic__block_8h.html">gr_basic_block.h</a>></span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment">/*!</span>
<a name="l00028"></a>00028 <span class="comment"> * \brief public constructor for gr_hier_block2</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment"> */</span>
<a name="l00031"></a>00031 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_hier_block2_sptr</a> <a class="code" href="gr__hier__block2_8h.html#aa4880934d41d92b98a00e101452e5e33" title="public constructor for gr_hier_block2">gr_make_hier_block2</a>(<span class="keyword">const</span> std::string &name,
<a name="l00032"></a>00032 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_io_signature_sptr</a> input_signature,
<a name="l00033"></a>00033 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_io_signature_sptr</a> output_signature);
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classgr__hier__block2__detail.html">gr_hier_block2_detail</a>;
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/*!</span>
<a name="l00038"></a>00038 <span class="comment"> * \brief Hierarchical container class for gr_block's and gr_hier_block2's</span>
<a name="l00039"></a>00039 <span class="comment"> * \ingroup container_blk</span>
<a name="l00040"></a>00040 <span class="comment"> * \ingroup base_blk</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a><a class="code" href="classgr__hier__block2.html">00043</a> <span class="keyword">class </span><a class="code" href="classgr__hier__block2.html" title="Hierarchical container class for gr_block&#39;s and gr_hier_block2&#39;s.">gr_hier_block2</a> : <span class="keyword">public</span> <a class="code" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ...">gr_basic_block</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">private</span>:
<a name="l00046"></a><a class="code" href="classgr__hier__block2.html#aabe5bf6b2754d0b512345d26eea22d9f">00046</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgr__hier__block2__detail.html">gr_hier_block2_detail</a>;
<a name="l00047"></a>00047 <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_hier_block2_sptr</a> <a class="code" href="classgr__hier__block2.html#aa4880934d41d92b98a00e101452e5e33" title="public constructor for gr_hier_block2">gr_make_hier_block2</a>(<span class="keyword">const</span> std::string &<a class="code" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>,
<a name="l00048"></a>00048 <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="code" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>,
<a name="l00049"></a>00049 <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="code" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>);
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /*!</span>
<a name="l00052"></a>00052 <span class="comment"> * \brief Private implementation details of gr_hier_block2</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a>00054 <a class="code" href="classgr__hier__block2__detail.html">gr_hier_block2_detail</a> *d_detail;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">protected</span>:
<a name="l00057"></a>00057 <a class="code" href="classgr__hier__block2.html#a324be02b1e3b00da10ed7b6df86f164f">gr_hier_block2</a>(<span class="keyword">const</span> std::string &<a class="code" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>,
<a name="l00058"></a>00058 <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="code" href="classgr__basic__block.html#a58f6d05e85931200f3771d3e50741281">input_signature</a>,
<a name="l00059"></a>00059 <a class="code" href="classboost_1_1shared__ptr.html">gr_io_signature_sptr</a> <a class="code" href="classgr__basic__block.html#add68b96f012dfe352700b4fd1c3a184a">output_signature</a>);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">public</span>:
<a name="l00062"></a>00062 <span class="keyword">virtual</span> <a class="code" href="classgr__hier__block2.html#a397a3307e074b26716401df03b5be398">~gr_hier_block2</a>();
<a name="l00063"></a>00063 <span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment"> /*!</span>
<a name="l00065"></a>00065 <span class="comment"> * \brief typedef for object returned from self().</span>
<a name="l00066"></a>00066 <span class="comment"> *</span>
<a name="l00067"></a>00067 <span class="comment"> * This type is only guaranteed to be passable to connect and disconnect.</span>
<a name="l00068"></a>00068 <span class="comment"> * No other assumptions should be made about it.</span>
<a name="l00069"></a>00069 <span class="comment"> */</span>
<a name="l00070"></a><a class="code" href="classgr__hier__block2.html#a39c600cf628c730eba5bd32cb7ccc861">00070</a> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> <a class="code" href="classgr__hier__block2.html#a39c600cf628c730eba5bd32cb7ccc861" title="typedef for object returned from self().">opaque_self</a>;
<a name="l00071"></a>00071 <span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /*!</span>
<a name="l00073"></a>00073 <span class="comment"> * \brief Return an object, representing the current block, which can be passed to connect.</span>
<a name="l00074"></a>00074 <span class="comment"> *</span>
<a name="l00075"></a>00075 <span class="comment"> * The returned object may only be used as an argument to connect or disconnect.</span>
<a name="l00076"></a>00076 <span class="comment"> * Any other use of self() results in unspecified (erroneous) behavior.</span>
<a name="l00077"></a>00077 <span class="comment"> */</span>
<a name="l00078"></a>00078 <a class="code" href="classboost_1_1shared__ptr.html">opaque_self</a> <span class="keyword">self</span>();
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /*!</span>
<a name="l00081"></a>00081 <span class="comment"> * \brief Add a stand-alone (possibly hierarchical) block to internal graph</span>
<a name="l00082"></a>00082 <span class="comment"> *</span>
<a name="l00083"></a>00083 <span class="comment"> * This adds a gr-block or hierarchical block to the internal graph</span>
<a name="l00084"></a>00084 <span class="comment"> * without wiring it to anything else.</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="classgr__hier__block2.html#af2eac32d80a8ead56e28835b2dbf5e9f" title="Add a stand-alone (possibly hierarchical) block to internal graph.">connect</a>(<a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> block);
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"> /*!</span>
<a name="l00089"></a>00089 <span class="comment"> * \brief Add gr-blocks or hierarchical blocks to internal graph and wire together</span>
<a name="l00090"></a>00090 <span class="comment"> *</span>
<a name="l00091"></a>00091 <span class="comment"> * This adds (if not done earlier by another connect) a pair of gr-blocks or </span>
<a name="l00092"></a>00092 <span class="comment"> * hierarchical blocks to the internal flowgraph, and wires the specified output </span>
<a name="l00093"></a>00093 <span class="comment"> * port to the specified input port.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="classgr__hier__block2.html#af2eac32d80a8ead56e28835b2dbf5e9f" title="Add a stand-alone (possibly hierarchical) block to internal graph.">connect</a>(<a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> src, <span class="keywordtype">int</span> src_port,
<a name="l00096"></a>00096 <a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> dst, <span class="keywordtype">int</span> dst_port);
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> /*!</span>
<a name="l00099"></a>00099 <span class="comment"> * \brief Remove a gr-block or hierarchical block from the internal flowgraph.</span>
<a name="l00100"></a>00100 <span class="comment"> *</span>
<a name="l00101"></a>00101 <span class="comment"> * This removes a gr-block or hierarchical block from the internal flowgraph,</span>
<a name="l00102"></a>00102 <span class="comment"> * disconnecting it from other blocks as needed.</span>
<a name="l00103"></a>00103 <span class="comment"> *</span>
<a name="l00104"></a>00104 <span class="comment"> */</span>
<a name="l00105"></a>00105 <span class="keywordtype">void</span> <a class="code" href="classgr__hier__block2.html#a3af3d7708f89011dfc398bc16f7222cb" title="Remove a gr-block or hierarchical block from the internal flowgraph.">disconnect</a>(<a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> block);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment"> /*!</span>
<a name="l00108"></a>00108 <span class="comment"> * \brief Disconnect a pair of gr-blocks or hierarchical blocks in internal</span>
<a name="l00109"></a>00109 <span class="comment"> * flowgraph.</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * This disconnects the specified input port from the specified output port</span>
<a name="l00112"></a>00112 <span class="comment"> * of a pair of gr-blocks or hierarchical blocks.</span>
<a name="l00113"></a>00113 <span class="comment"> */</span>
<a name="l00114"></a>00114 <span class="keywordtype">void</span> <a class="code" href="classgr__hier__block2.html#a3af3d7708f89011dfc398bc16f7222cb" title="Remove a gr-block or hierarchical block from the internal flowgraph.">disconnect</a>(<a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> src, <span class="keywordtype">int</span> src_port,
<a name="l00115"></a>00115 <a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> dst, <span class="keywordtype">int</span> dst_port);
<a name="l00116"></a>00116 <span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment"> /*!</span>
<a name="l00118"></a>00118 <span class="comment"> * \brief Disconnect all connections in the internal flowgraph.</span>
<a name="l00119"></a>00119 <span class="comment"> *</span>
<a name="l00120"></a>00120 <span class="comment"> * This call removes all output port to input port connections in the internal</span>
<a name="l00121"></a>00121 <span class="comment"> * flowgraph.</span>
<a name="l00122"></a>00122 <span class="comment"> */</span>
<a name="l00123"></a>00123 <span class="keywordtype">void</span> <a class="code" href="classgr__hier__block2.html#ad695c24808d24ad09428380fd213306d" title="Disconnect all connections in the internal flowgraph.">disconnect_all</a>();
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment"> /*!</span>
<a name="l00126"></a>00126 <span class="comment"> * Lock a flowgraph in preparation for reconfiguration. When an equal</span>
<a name="l00127"></a>00127 <span class="comment"> * number of calls to lock() and unlock() have occurred, the flowgraph</span>
<a name="l00128"></a>00128 <span class="comment"> * will be reconfigured.</span>
<a name="l00129"></a>00129 <span class="comment"> *</span>
<a name="l00130"></a>00130 <span class="comment"> * N.B. lock() and unlock() may not be called from a flowgraph thread</span>
<a name="l00131"></a>00131 <span class="comment"> * (E.g., gr_block::work method) or deadlock will occur when</span>
<a name="l00132"></a>00132 <span class="comment"> * reconfiguration happens.</span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__hier__block2.html#ac99f0dc1037ec2ca81721da8127c6d25">lock</a>();
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> /*!</span>
<a name="l00137"></a>00137 <span class="comment"> * Unlock a flowgraph in preparation for reconfiguration. When an equal</span>
<a name="l00138"></a>00138 <span class="comment"> * number of calls to lock() and unlock() have occurred, the flowgraph</span>
<a name="l00139"></a>00139 <span class="comment"> * will be reconfigured.</span>
<a name="l00140"></a>00140 <span class="comment"> *</span>
<a name="l00141"></a>00141 <span class="comment"> * N.B. lock() and unlock() may not be called from a flowgraph thread</span>
<a name="l00142"></a>00142 <span class="comment"> * (E.g., gr_block::work method) or deadlock will occur when</span>
<a name="l00143"></a>00143 <span class="comment"> * reconfiguration happens.</span>
<a name="l00144"></a>00144 <span class="comment"> */</span>
<a name="l00145"></a>00145 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__hier__block2.html#a35d938ecc725c7992fb104cb2f321ebf">unlock</a>();
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="comment">// This is a public method for ease of code organization, but should be</span>
<a name="l00148"></a>00148 <span class="comment">// ignored by the user.</span>
<a name="l00149"></a>00149 <a class="code" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> <a class="code" href="classgr__hier__block2.html#a0f7b989d0496f41e8c30b822a25eba21">flatten</a>() <span class="keyword">const</span>;
<a name="l00150"></a>00150 };
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="keyword">inline</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_hier_block2_sptr</a> cast_to_hier_block2_sptr(<a class="code" href="classboost_1_1shared__ptr.html">gr_basic_block_sptr</a> block) {
<a name="l00153"></a>00153 <span class="keywordflow">return</span> boost::dynamic_pointer_cast<<a class="code" href="classgr__hier__block2.html" title="Hierarchical container class for gr_block&#39;s and gr_hier_block2&#39;s.">gr_hier_block2</a>, <a class="code" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare abstraction of an ...">gr_basic_block</a>>(block);
<a name="l00154"></a>00154 }
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_HIER_BLOCK2_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__hier__block2_8h.html">gr_hier_block2.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
>
4457
