<!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_scheduler_sts 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_scheduler_sts Class Reference</h1><!-- doxytag: class="gr_scheduler_sts" --><!-- doxytag: inherits="gr_scheduler" -->
<p>Concrete scheduler that uses the single_threaded_scheduler.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__scheduler__sts_8h_source.html">gr_scheduler_sts.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_scheduler_sts:</div>
<div class="dynsection">
<div class="center"><img src="classgr__scheduler__sts__inherit__graph.png" border="0" usemap="#gr__scheduler__sts_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__scheduler__sts_inherit__map" id="gr__scheduler__sts_inherit__map">
<area shape="rect" id="node2" href="classgr__scheduler.html" title="Abstract scheduler that takes a flattened flow graph and runs it." alt="" coords="17,5,113,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__scheduler__sts-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__scheduler__sts.html#a505ddcaaa2435330684e2171d121bdb9">~gr_scheduler_sts</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler__sts.html#a3f8dd7ae4f1140e7e45b073eaf438c2d">stop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the scheduler to stop executing. <a href="#a3f8dd7ae4f1140e7e45b073eaf438c2d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler__sts.html#a04c1d2ea387752e303586164eac90fc9">wait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Block until the graph is done. <a href="#a04c1d2ea387752e303586164eac90fc9"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classboost_1_1shared__ptr.html">gr_scheduler_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler__sts.html#acabef37ab1cac6affe561fb869cc8c76">make</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> ffg)</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__scheduler__sts.html#af4ec3fd3f59e2ebef8401c8377daecfc">gr_scheduler_sts</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> ffg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a scheduler and begin evaluating the graph. <a href="#af4ec3fd3f59e2ebef8401c8377daecfc"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Concrete scheduler that uses the single_threaded_scheduler. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af4ec3fd3f59e2ebef8401c8377daecfc"></a><!-- doxytag: member="gr_scheduler_sts::gr_scheduler_sts" ref="af4ec3fd3f59e2ebef8401c8377daecfc" args="(gr_flat_flowgraph_sptr ffg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_scheduler_sts::gr_scheduler_sts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> </td>
<td class="paramname"> <em>ffg</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a scheduler and begin evaluating the graph. </p>
<p>The scheduler will continue running until all blocks until they report that they are done or the stop method is called. </p>
</div>
</div>
<a class="anchor" id="a505ddcaaa2435330684e2171d121bdb9"></a><!-- doxytag: member="gr_scheduler_sts::~gr_scheduler_sts" ref="a505ddcaaa2435330684e2171d121bdb9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_scheduler_sts::~gr_scheduler_sts </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="acabef37ab1cac6affe561fb869cc8c76"></a><!-- doxytag: member="gr_scheduler_sts::make" ref="acabef37ab1cac6affe561fb869cc8c76" args="(gr_flat_flowgraph_sptr ffg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classboost_1_1shared__ptr.html">gr_scheduler_sptr</a> gr_scheduler_sts::make </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> </td>
<td class="paramname"> <em>ffg</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3f8dd7ae4f1140e7e45b073eaf438c2d"></a><!-- doxytag: member="gr_scheduler_sts::stop" ref="a3f8dd7ae4f1140e7e45b073eaf438c2d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_scheduler_sts::stop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tell the scheduler to stop executing. </p>
<p>Implements <a class="el" href="classgr__scheduler.html#a9aa911eac6894694dfb67a59cc4a4e46">gr_scheduler</a>.</p>
</div>
</div>
<a class="anchor" id="a04c1d2ea387752e303586164eac90fc9"></a><!-- doxytag: member="gr_scheduler_sts::wait" ref="a04c1d2ea387752e303586164eac90fc9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_scheduler_sts::wait </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Block until the graph is done. </p>
<p>Implements <a class="el" href="classgr__scheduler.html#a27993c1e1a34a5d29a3ede97b731506e">gr_scheduler</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__scheduler__sts_8h_source.html">gr_scheduler_sts.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>
