<!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 Class Reference</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('classgr__scheduler.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <h1>gr_scheduler Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="gr_scheduler" --> <p>Abstract scheduler that takes a flattened flow graph and runs it. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="gr__scheduler_8h_source.html">gr_scheduler.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gr_scheduler:</div> <div class="dyncontent"> <div class="center"><img src="classgr__scheduler__inherit__graph.png" border="0" usemap="#gr__scheduler_inherit__map" alt="Inheritance graph"/></div> <map name="gr__scheduler_inherit__map" id="gr__scheduler_inherit__map"> <area shape="rect" id="node3" href="classgr__scheduler__sts.html" title="Concrete scheduler that uses the single_threaded_scheduler." alt="" coords="5,83,125,112"/><area shape="rect" id="node5" href="classgr__scheduler__tpb.html" title="Concrete scheduler that uses a kernel thread-per-block." alt="" coords="149,83,269,112"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__scheduler-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> 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.html#a726c681fc705ecaa92c47af049b84c1b">gr_scheduler</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="#a726c681fc705ecaa92c47af049b84c1b"></a><br/></td></tr> <tr><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><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler.html#a9aa911eac6894694dfb67a59cc4a4e46">stop</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the scheduler to stop executing. <a href="#a9aa911eac6894694dfb67a59cc4a4e46"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__scheduler.html#a27993c1e1a34a5d29a3ede97b731506e">wait</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Block until the graph is done. <a href="#a27993c1e1a34a5d29a3ede97b731506e"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Abstract scheduler that takes a flattened flow graph and runs it. </p> <p>Preconditions: details, buffers and buffer readers have been assigned. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a726c681fc705ecaa92c47af049b84c1b"></a><!-- doxytag: member="gr_scheduler::gr_scheduler" ref="a726c681fc705ecaa92c47af049b84c1b" args="(gr_flat_flowgraph_sptr ffg)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_scheduler::gr_scheduler </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></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="a997dc366c2a0b1bcdd66e3b145a95a31"></a><!-- doxytag: member="gr_scheduler::~gr_scheduler" ref="a997dc366c2a0b1bcdd66e3b145a95a31" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual gr_scheduler::~gr_scheduler </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="a9aa911eac6894694dfb67a59cc4a4e46"></a><!-- doxytag: member="gr_scheduler::stop" ref="a9aa911eac6894694dfb67a59cc4a4e46" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gr_scheduler::stop </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Tell the scheduler to stop executing. </p> <p>Implemented in <a class="el" href="classgr__scheduler__sts.html#a3f8dd7ae4f1140e7e45b073eaf438c2d">gr_scheduler_sts</a>, and <a class="el" href="classgr__scheduler__tpb.html#a1d830db53d8d5d2e962d1797fef63213">gr_scheduler_tpb</a>.</p> </div> </div> <a class="anchor" id="a27993c1e1a34a5d29a3ede97b731506e"></a><!-- doxytag: member="gr_scheduler::wait" ref="a27993c1e1a34a5d29a3ede97b731506e" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void gr_scheduler::wait </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Block until the graph is done. </p> <p>Implemented in <a class="el" href="classgr__scheduler__sts.html#a04c1d2ea387752e303586164eac90fc9">gr_scheduler_sts</a>, and <a class="el" href="classgr__scheduler__tpb.html#a0d3dfd4320dcb92cfcfbdcb91d43bed2">gr_scheduler_tpb</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gr__scheduler_8h_source.html">gr_scheduler.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classgr__scheduler.html">gr_scheduler</a> </li> <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by  <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>