<!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 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.2 -->
<div class="contents">
<h1>gr_top_block Class Reference<br/>
<small>
[<a class="el" href="group__container__blk.html">Top Block and Hierarchical Block Base Classes</a>]</small>
</h1><!-- doxytag: class="gr_top_block" --><!-- doxytag: inherits="gr_hier_block2" -->
<p>Top-level hierarchical block representing a flowgraph.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__top__block_8h_source.html">gr_top_block.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_top_block:</div>
<div class="dynsection">
<div class="center"><img src="classgr__top__block__inherit__graph.png" border="0" usemap="#gr__top__block_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__top__block_inherit__map" id="gr__top__block_inherit__map">
<area shape="rect" id="node7" href="classusrp__rx__cfile.html" title="usrp_rx_cfile" alt="" coords="5,237,101,267"/><area shape="rect" id="node9" href="classusrp__siggen.html" title="usrp_siggen" alt="" coords="125,237,216,267"/><area shape="rect" id="node2" href="classgr__hier__block2.html" title="Hierarchical container class for gr_block's and gr_hier_block2's." alt="" coords="59,83,165,112"/><area shape="rect" id="node4" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="57,5,167,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__top__block-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__top__block.html#acff39e01cdd15bb9acd3ceb25662a1ac">~gr_top_block</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#a3bafcd766eb6a923b1a11ea5ede98778">run</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The simple interface to running a flowgraph. <a href="#a3bafcd766eb6a923b1a11ea5ede98778"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#ac6d731a193ab26963cd0e9face5cef92">start</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#a852891aedd9729fc8d3da1044656f196">stop</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#a1f969afd71e0c04afb44e78dc80b0bab">wait</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#a9f3a470e46e83e4863d3713d1939a965">lock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#a96784ae9c45d0933b9af53eba881eebc">unlock</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#ab6bd46945c9117fb343f4c293cf23990">dump</a> ()</td></tr>
<tr><td colspan="2"><h2>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__top__block.html#af671df672a4814a6d559e7b90c6a970e">gr_top_block</a> (const std::string &name)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_top_block_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__top__block.html#a8d25cd0978cec64039e2d5789056a89c">gr_make_top_block</a> (const std::string &name)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Top-level hierarchical block representing a flowgraph. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af671df672a4814a6d559e7b90c6a970e"></a><!-- doxytag: member="gr_top_block::gr_top_block" ref="af671df672a4814a6d559e7b90c6a970e" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_top_block::gr_top_block </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acff39e01cdd15bb9acd3ceb25662a1ac"></a><!-- doxytag: member="gr_top_block::~gr_top_block" ref="acff39e01cdd15bb9acd3ceb25662a1ac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_top_block::~gr_top_block </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="ab6bd46945c9117fb343f4c293cf23990"></a><!-- doxytag: member="gr_top_block::dump" ref="ab6bd46945c9117fb343f4c293cf23990" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_top_block::dump </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Displays flattened flowgraph edges and block connectivity </p>
</div>
</div>
<a class="anchor" id="a9f3a470e46e83e4863d3713d1939a965"></a><!-- doxytag: member="gr_top_block::lock" ref="a9f3a470e46e83e4863d3713d1939a965" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_top_block::lock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lock a flowgraph in preparation for reconfiguration. When an equal number of calls to <a class="el" href="classgr__top__block.html#a9f3a470e46e83e4863d3713d1939a965">lock()</a> and <a class="el" href="classgr__top__block.html#a96784ae9c45d0933b9af53eba881eebc">unlock()</a> have occurred, the flowgraph will be reconfigured.</p>
<p>N.B. <a class="el" href="classgr__top__block.html#a9f3a470e46e83e4863d3713d1939a965">lock()</a> and <a class="el" href="classgr__top__block.html#a96784ae9c45d0933b9af53eba881eebc">unlock()</a> may not be called from a flowgraph thread (E.g., gr_block::work method) or deadlock will occur when reconfiguration happens. </p>
<p>Reimplemented from <a class="el" href="classgr__hier__block2.html#ac99f0dc1037ec2ca81721da8127c6d25">gr_hier_block2</a>.</p>
</div>
</div>
<a class="anchor" id="a3bafcd766eb6a923b1a11ea5ede98778"></a><!-- doxytag: member="gr_top_block::run" ref="a3bafcd766eb6a923b1a11ea5ede98778" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_top_block::run </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The simple interface to running a flowgraph. </p>
<p>Calls <a class="el" href="classgr__top__block.html#ac6d731a193ab26963cd0e9face5cef92">start()</a> then <a class="el" href="classgr__top__block.html#a1f969afd71e0c04afb44e78dc80b0bab">wait()</a>. Used to run a flowgraph that will stop on its own, or when another thread will call <a class="el" href="classgr__top__block.html#a852891aedd9729fc8d3da1044656f196">stop()</a>. </p>
</div>
</div>
<a class="anchor" id="ac6d731a193ab26963cd0e9face5cef92"></a><!-- doxytag: member="gr_top_block::start" ref="ac6d731a193ab26963cd0e9face5cef92" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_top_block::start </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start the contained flowgraph. Creates one or more threads to execute the flow graph. Returns to the caller once the threads are created. Calling <a class="el" href="classgr__top__block.html#ac6d731a193ab26963cd0e9face5cef92">start()</a> on a top_block that is already started IS an error. </p>
</div>
</div>
<a class="anchor" id="a852891aedd9729fc8d3da1044656f196"></a><!-- doxytag: member="gr_top_block::stop" ref="a852891aedd9729fc8d3da1044656f196" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_top_block::stop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop the running flowgraph. Notifies each thread created by the scheduler to shutdown, then returns to caller. Calling <a class="el" href="classgr__top__block.html#a852891aedd9729fc8d3da1044656f196">stop()</a> on a top_block that is already stopped IS NOT an error. </p>
</div>
</div>
<a class="anchor" id="a96784ae9c45d0933b9af53eba881eebc"></a><!-- doxytag: member="gr_top_block::unlock" ref="a96784ae9c45d0933b9af53eba881eebc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gr_top_block::unlock </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unlock a flowgraph in preparation for reconfiguration. When an equal number of calls to <a class="el" href="classgr__top__block.html#a9f3a470e46e83e4863d3713d1939a965">lock()</a> and <a class="el" href="classgr__top__block.html#a96784ae9c45d0933b9af53eba881eebc">unlock()</a> have occurred, the flowgraph will be reconfigured.</p>
<p>N.B. <a class="el" href="classgr__top__block.html#a9f3a470e46e83e4863d3713d1939a965">lock()</a> and <a class="el" href="classgr__top__block.html#a96784ae9c45d0933b9af53eba881eebc">unlock()</a> may not be called from a flowgraph thread (E.g., gr_block::work method) or deadlock will occur when reconfiguration happens. </p>
<p>Reimplemented from <a class="el" href="classgr__hier__block2.html#a35d938ecc725c7992fb104cb2f321ebf">gr_hier_block2</a>.</p>
</div>
</div>
<a class="anchor" id="a1f969afd71e0c04afb44e78dc80b0bab"></a><!-- doxytag: member="gr_top_block::wait" ref="a1f969afd71e0c04afb44e78dc80b0bab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_top_block::wait </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for a flowgraph to complete. Flowgraphs complete when either (1) all blocks indicate that they are done (typically only when using gr.file_source, or gr.head, or (2) after <a class="el" href="classgr__top__block.html#a852891aedd9729fc8d3da1044656f196">stop()</a> has been called to request shutdown. Calling wait on a top_block that is not running IS NOT an error (wait returns w/o blocking). </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a8d25cd0978cec64039e2d5789056a89c"></a><!-- doxytag: member="gr_top_block::gr_make_top_block" ref="a8d25cd0978cec64039e2d5789056a89c" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_top_block_sptr</a> gr_make_top_block </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [friend]</code></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__top__block_8h_source.html">gr_top_block.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
