<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_scheduler_sts Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classgr__scheduler__sts.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classgr__scheduler__sts-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr_scheduler_sts Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Concrete scheduler that uses the single_threaded_scheduler.
<a href="classgr__scheduler__sts.html#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="dyncontent">
<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,80,113,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a505ddcaaa2435330684e2171d121bdb9"><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 class="separator:a505ddcaaa2435330684e2171d121bdb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f8dd7ae4f1140e7e45b073eaf438c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler__sts.html#a3f8dd7ae4f1140e7e45b073eaf438c2d">stop</a> ()</td></tr>
<tr class="memdesc:a3f8dd7ae4f1140e7e45b073eaf438c2d"><td class="mdescLeft"> </td><td class="mdescRight">Tell the scheduler to stop executing. <a href="#a3f8dd7ae4f1140e7e45b073eaf438c2d"></a><br/></td></tr>
<tr class="separator:a3f8dd7ae4f1140e7e45b073eaf438c2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04c1d2ea387752e303586164eac90fc9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler__sts.html#a04c1d2ea387752e303586164eac90fc9">wait</a> ()</td></tr>
<tr class="memdesc:a04c1d2ea387752e303586164eac90fc9"><td class="mdescLeft"> </td><td class="mdescRight">Block until the graph is done. <a href="#a04c1d2ea387752e303586164eac90fc9"></a><br/></td></tr>
<tr class="separator:a04c1d2ea387752e303586164eac90fc9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classgr__scheduler"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgr__scheduler')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgr__scheduler.html">gr_scheduler</a></td></tr>
<tr class="memitem:a35163aaf31e92ba884f37513e6f89304 inherit pub_methods_classgr__scheduler"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler.html#a35163aaf31e92ba884f37513e6f89304">gr_scheduler</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> ffg, int max_noutput_items)</td></tr>
<tr class="memdesc:a35163aaf31e92ba884f37513e6f89304 inherit pub_methods_classgr__scheduler"><td class="mdescLeft"> </td><td class="mdescRight">Construct a scheduler and begin evaluating the graph. <a href="#a35163aaf31e92ba884f37513e6f89304"></a><br/></td></tr>
<tr class="separator:a35163aaf31e92ba884f37513e6f89304 inherit pub_methods_classgr__scheduler"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a997dc366c2a0b1bcdd66e3b145a95a31 inherit pub_methods_classgr__scheduler"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler.html#a997dc366c2a0b1bcdd66e3b145a95a31">~gr_scheduler</a> ()</td></tr>
<tr class="separator:a997dc366c2a0b1bcdd66e3b145a95a31 inherit pub_methods_classgr__scheduler"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af89f32ea2c6d9069d5e6c16bbb2774dd"><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#af89f32ea2c6d9069d5e6c16bbb2774dd">make</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> ffg, int max_noutput_items)</td></tr>
<tr class="separator:af89f32ea2c6d9069d5e6c16bbb2774dd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a52515bb2a35e49e50ef1052d0ef0731d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler__sts.html#a52515bb2a35e49e50ef1052d0ef0731d">gr_scheduler_sts</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_flat_flowgraph_sptr</a> ffg, int max_noutput_items)</td></tr>
<tr class="memdesc:a52515bb2a35e49e50ef1052d0ef0731d"><td class="mdescLeft"> </td><td class="mdescRight">Construct a scheduler and begin evaluating the graph. <a href="#a52515bb2a35e49e50ef1052d0ef0731d"></a><br/></td></tr>
<tr class="separator:a52515bb2a35e49e50ef1052d0ef0731d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Concrete scheduler that uses the single_threaded_scheduler. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a52515bb2a35e49e50ef1052d0ef0731d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_noutput_items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </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>
<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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af89f32ea2c6d9069d5e6c16bbb2774dd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_noutput_items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3f8dd7ae4f1140e7e45b073eaf438c2d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_scheduler_sts::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_scheduler_sts::wait </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classgr__scheduler__sts.html">gr_scheduler_sts</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:38 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
