<!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: mb_runtime 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>mb_runtime Class Reference</h1><!-- doxytag: class="mb_runtime" -->
<p>Abstract runtime support for m-blocks.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="runtime_8h_source.html">runtime.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mb_runtime:</div>
<div class="dynsection">
<div class="center"><img src="classmb__runtime__inherit__graph.png" border="0" usemap="#mb__runtime_inherit__map" alt="Inheritance graph"/></div>
<map name="mb__runtime_inherit__map" id="mb__runtime_inherit__map">
<area shape="rect" id="node3" href="classmb__runtime__base.html" title="mb_runtime_base" alt="" coords="91,83,216,112"/><area shape="rect" id="node5" href="classmb__runtime__nop.html" title="Concrete runtime that does nothing. Used only during early QA tests." alt="" coords="5,160,123,189"/><area shape="rect" id="node7" href="classmb__runtime__thread__per__block.html" title="Concrete runtime that uses a thread per mblock." alt="" coords="147,160,341,189"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmb__runtime-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="classmb__runtime.html#a2159f1f7f521a45a87469ffbc91f0f0c">mb_runtime</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__runtime.html#a15c86150ffac906d49d062541e9961d1">~mb_runtime</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__runtime.html#ab197730ccb786c72e00d048b6e9f8122">run</a> (const std::string &instance_name, const std::string &class_name, <a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> user_arg, <a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> *result=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and run the specified mblock hierarchy. <a href="#ab197730ccb786c72e00d048b6e9f8122"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">mb_mblock_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__runtime.html#a8a463ee0ea38c3d82f682cc4a1f07e7f">top</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">mb_mblock_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmb__runtime.html#abd8efd53013d2a84b88282a4c770dec0">d_top</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Abstract runtime support for m-blocks. </p>
<p>There should generally be only a single instance of this class. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2159f1f7f521a45a87469ffbc91f0f0c"></a><!-- doxytag: member="mb_runtime::mb_runtime" ref="a2159f1f7f521a45a87469ffbc91f0f0c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mb_runtime::mb_runtime </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a15c86150ffac906d49d062541e9961d1"></a><!-- doxytag: member="mb_runtime::~mb_runtime" ref="a15c86150ffac906d49d062541e9961d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mb_runtime::~mb_runtime </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab197730ccb786c72e00d048b6e9f8122"></a><!-- doxytag: member="mb_runtime::run" ref="ab197730ccb786c72e00d048b6e9f8122" args="(const std::string &instance_name, const std::string &class_name, pmt_t user_arg, pmt_t *result=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> mb_runtime::run </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>instance_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>class_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> </td>
<td class="paramname"> <em>user_arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">pmt_t</a> * </td>
<td class="paramname"> <em>result</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct and run the specified mblock hierarchy. </p>
<p>This routine turns into the m-block scheduler, and blocks until the system is shutdown.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>instance_name</em> </td><td>name of the top-level mblock (conventionally "top") </td></tr>
<tr><td valign="top"></td><td valign="top"><em>class_name</em> </td><td>The class of the top-level mblock to create. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_arg</em> </td><td>The argument to pass to the top-level mblock constructor </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>The value passed to shutdown_all.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the system ran successfully. </dd></dl>
<p>Implemented in <a class="el" href="classmb__runtime__nop.html#a720f923c056c9571220152c42be90946">mb_runtime_nop</a>, and <a class="el" href="classmb__runtime__thread__per__block.html#a44b1de16c705e362a11ad77fcaa2f885">mb_runtime_thread_per_block</a>.</p>
</div>
</div>
<a class="anchor" id="a8a463ee0ea38c3d82f682cc4a1f07e7f"></a><!-- doxytag: member="mb_runtime::top" ref="a8a463ee0ea38c3d82f682cc4a1f07e7f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">mb_mblock_sptr</a> mb_runtime::top </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="runtime_8h_source.html#l00041">d_top</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="abd8efd53013d2a84b88282a4c770dec0"></a><!-- doxytag: member="mb_runtime::d_top" ref="abd8efd53013d2a84b88282a4c770dec0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">mb_mblock_sptr</a> <a class="el" href="classmb__runtime.html#abd8efd53013d2a84b88282a4c770dec0">mb_runtime::d_top</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="runtime_8h_source.html#l00066">top()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="runtime_8h_source.html">runtime.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>
