Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 5361

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: gr_top_block.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__top__block_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gr_top_block.h</h1>  </div>
</div>
<div class="contents">
<a href="gr__top__block_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 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 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GR_TOP_BLOCK_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GR_TOP_BLOCK_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="gr__hier__block2_8h.html">gr_hier_block2.h</a>&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="code" href="classgr__top__block__impl.html" title="Abstract implementation details of gr_top_blockThe actual implementation of gr_top_block. Separate class allows decoupling of changes from dependent classes.">gr_top_block_impl</a>;
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_top_block_sptr</a> <a class="code" href="gr__top__block_8h.html#a8d25cd0978cec64039e2d5789056a89c">gr_make_top_block</a>(<span class="keyword">const</span> std::string &amp;name);
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment">/*!</span>
<a name="l00033"></a>00033 <span class="comment"> *\brief Top-level hierarchical block representing a flowgraph</span>
<a name="l00034"></a>00034 <span class="comment"> * \ingroup container_blk</span>
<a name="l00035"></a>00035 <span class="comment"> *</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a><a class="code" href="classgr__top__block.html">00037</a> <span class="keyword">class </span><a class="code" href="classgr__top__block.html" title="Top-level hierarchical block representing a flowgraph.">gr_top_block</a> : <span class="keyword">public</span> <a class="code" href="classgr__hier__block2.html" title="Hierarchical container class for gr_block&amp;#39;s and gr_hier_block2&amp;#39;s.">gr_hier_block2</a>
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">private</span>:
<a name="l00040"></a>00040   <span class="keyword">friend</span> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">gr_top_block_sptr</a> <a class="code" href="classgr__top__block.html#a8d25cd0978cec64039e2d5789056a89c">gr_make_top_block</a>(<span class="keyword">const</span> std::string &amp;<a class="code" href="classgr__basic__block.html#aa12a20d8b8eab341da935530d29299d2">name</a>);
<a name="l00041"></a>00041 
<a name="l00042"></a>00042   <a class="code" href="classgr__top__block__impl.html" title="Abstract implementation details of gr_top_blockThe actual implementation of gr_top_block. Separate class allows decoupling of changes from dependent classes.">gr_top_block_impl</a> *d_impl;
<a name="l00043"></a>00043 
<a name="l00044"></a>00044 <span class="keyword">protected</span>:
<a name="l00045"></a>00045   <a class="code" href="classgr__top__block.html#af671df672a4814a6d559e7b90c6a970e">gr_top_block</a>(<span class="keyword">const</span> std::string &amp;name);
<a name="l00046"></a>00046     
<a name="l00047"></a>00047 <span class="keyword">public</span>:
<a name="l00048"></a>00048   <a class="code" href="classgr__top__block.html#acff39e01cdd15bb9acd3ceb25662a1ac">~gr_top_block</a>();
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">  /*!</span>
<a name="l00051"></a>00051 <span class="comment">   * \brief The simple interface to running a flowgraph.</span>
<a name="l00052"></a>00052 <span class="comment">   *</span>
<a name="l00053"></a>00053 <span class="comment">   * Calls start() then wait().  Used to run a flowgraph that will stop</span>
<a name="l00054"></a>00054 <span class="comment">   * on its own, or when another thread will call stop().</span>
<a name="l00055"></a>00055 <span class="comment">   */</span>
<a name="l00056"></a>00056   <span class="keywordtype">void</span> <a class="code" href="classgr__top__block.html#a3bafcd766eb6a923b1a11ea5ede98778" title="The simple interface to running a flowgraph.">run</a>();
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">  /*!</span>
<a name="l00059"></a>00059 <span class="comment">   * Start the contained flowgraph.  Creates one or more threads to</span>
<a name="l00060"></a>00060 <span class="comment">   * execute the flow graph.  Returns to the caller once the threads</span>
<a name="l00061"></a>00061 <span class="comment">   * are created.  Calling start() on a top_block that is already</span>
<a name="l00062"></a>00062 <span class="comment">   * started IS an error.</span>
<a name="l00063"></a>00063 <span class="comment">   */</span>
<a name="l00064"></a>00064   <span class="keywordtype">void</span> <a class="code" href="classgr__top__block.html#ac6d731a193ab26963cd0e9face5cef92">start</a>();
<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">   * Stop the running flowgraph.  Notifies each thread created by the</span>
<a name="l00068"></a>00068 <span class="comment">   * scheduler to shutdown, then returns to caller. Calling stop() on</span>
<a name="l00069"></a>00069 <span class="comment">   * a top_block that is already stopped IS NOT an error.</span>
<a name="l00070"></a>00070 <span class="comment">   */</span>
<a name="l00071"></a>00071   <span class="keywordtype">void</span> <a class="code" href="classgr__top__block.html#a852891aedd9729fc8d3da1044656f196">stop</a>();
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">  /*!</span>
<a name="l00074"></a>00074 <span class="comment">   * Wait for a flowgraph to complete.  Flowgraphs complete when</span>
<a name="l00075"></a>00075 <span class="comment">   * either (1) all blocks indicate that they are done (typically only</span>
<a name="l00076"></a>00076 <span class="comment">   * when using gr.file_source, or gr.head, or (2) after stop() has been</span>
<a name="l00077"></a>00077 <span class="comment">   * called to request shutdown.  Calling wait on a top_block that is</span>
<a name="l00078"></a>00078 <span class="comment">   * not running IS NOT an error (wait returns w/o blocking).</span>
<a name="l00079"></a>00079 <span class="comment">   */</span>
<a name="l00080"></a>00080   <span class="keywordtype">void</span> <a class="code" href="classgr__top__block.html#a1f969afd71e0c04afb44e78dc80b0bab">wait</a>();
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">  /*!</span>
<a name="l00083"></a>00083 <span class="comment">   * Lock a flowgraph in preparation for reconfiguration.  When an equal</span>
<a name="l00084"></a>00084 <span class="comment">   * number of calls to lock() and unlock() have occurred, the flowgraph</span>
<a name="l00085"></a>00085 <span class="comment">   * will be reconfigured.</span>
<a name="l00086"></a>00086 <span class="comment">   *</span>
<a name="l00087"></a>00087 <span class="comment">   * N.B. lock() and unlock() may not be called from a flowgraph thread</span>
<a name="l00088"></a>00088 <span class="comment">   * (E.g., gr_block::work method) or deadlock will occur when</span>
<a name="l00089"></a>00089 <span class="comment">   * reconfiguration happens.</span>
<a name="l00090"></a>00090 <span class="comment">   */</span>
<a name="l00091"></a>00091   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__top__block.html#a9f3a470e46e83e4863d3713d1939a965">lock</a>();
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">  /*!</span>
<a name="l00094"></a>00094 <span class="comment">   * Unlock a flowgraph in preparation for reconfiguration.  When an equal</span>
<a name="l00095"></a>00095 <span class="comment">   * number of calls to lock() and unlock() have occurred, the flowgraph</span>
<a name="l00096"></a>00096 <span class="comment">   * will be reconfigured.</span>
<a name="l00097"></a>00097 <span class="comment">   *</span>
<a name="l00098"></a>00098 <span class="comment">   * N.B. lock() and unlock() may not be called from a flowgraph thread</span>
<a name="l00099"></a>00099 <span class="comment">   * (E.g., gr_block::work method) or deadlock will occur when</span>
<a name="l00100"></a>00100 <span class="comment">   * reconfiguration happens.</span>
<a name="l00101"></a>00101 <span class="comment">   */</span>
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgr__top__block.html#a96784ae9c45d0933b9af53eba881eebc">unlock</a>();
<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="comment">   * Displays flattened flowgraph edges and block connectivity</span>
<a name="l00106"></a>00106 <span class="comment">   */</span>
<a name="l00107"></a>00107   <span class="keywordtype">void</span> <a class="code" href="classgr__top__block.html#ab6bd46945c9117fb343f4c293cf23990">dump</a>();
<a name="l00108"></a>00108 };
<a name="l00109"></a>00109 
<a name="l00110"></a>00110 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GR_TOP_BLOCK_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gr__top__block_8h.html">gr_top_block.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional