<!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: gc_job_manager.h File 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('gc__job__manager_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>gc_job_manager.h File Reference</h1> </div> </div> <div class="contents"> <div class="textblock"><code>#include <boost/utility.hpp></code><br/> <code>#include <boost/shared_ptr.hpp></code><br/> <code>#include <vector></code><br/> <code>#include <string></code><br/> <code>#include <stdexcept></code><br/> <code>#include <libspe2.h></code><br/> <code>#include "<a class="el" href="gc__job__desc_8h_source.html">gc_job_desc.h</a>"</code><br/> </div><div class="textblock"><div class="dynheader"> Include dependency graph for gc_job_manager.h:</div> <div class="dyncontent"> <div class="center"><img src="gc__job__manager_8h__incl.png" border="0" usemap="#gc__job__manager_8h" alt=""/></div> <map name="gc__job__manager_8h" id="gc__job__manager_8h"> <area shape="rect" id="node15" href="gc__job__desc_8h.html" title="gc_job_desc.h" alt="" coords="672,83,779,112"/></map> </div> </div> <p><a href="gc__job__manager_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgc__jm__options.html">gc_jm_options</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__exception.html">gc_exception</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__unknown__proc.html">gc_unknown_proc</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__bad__alloc.html">gc_bad_alloc</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__bad__align.html">gc_bad_align</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__bad__submit.html">gc_bad_submit</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgc__job__manager.html">gc_job_manager</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract class that manages SPE jobs.There is typically a single instance derived from this class. It is safe to call its methods from any thread. <a href="classgc__job__manager.html#_details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="enum-members"></a> Enumerations</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038c">gc_wait_mode</a> { <a class="el" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038ca03e0a1c46214d9006a4078ab88f523be">GC_WAIT_ANY</a>, <a class="el" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038ca1281576bc1c87da9044b2bbbba101963">GC_WAIT_ALL</a> }</td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="gc__job__manager_8h.html#a1dd4518136ea1dc7bf0dde42ad7a4803">gc_program_handle_from_filename</a> (const std::string &filename)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> to an spe_program_handle_t. <a href="#a1dd4518136ea1dc7bf0dde42ad7a4803"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="gc__job__manager_8h.html#a97e12792ec99a2ae9efccb37e309091a">gc_program_handle_from_address</a> (spe_program_handle_t *handle)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> to an spe_program_handle_t. <a href="#a97e12792ec99a2ae9efccb37e309091a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="gc__job__manager_8h.html#ad0c489d72a6e526f278f3e2962597ebd">gc_job_status_string</a> (<a class="el" href="gc__job__desc_8h.html#a8e110a97291b439c37ed61b0931bb0dd">gc_job_status_t</a> status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">map gc_job_status_t into a string <a href="#ad0c489d72a6e526f278f3e2962597ebd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="gc__job__manager_8h.html#ababcb62055f6ee7f1de4595669e52d2a">gc_make_job_manager</a> (const <a class="el" href="structgc__jm__options.html">gc_jm_options</a> *options=0)</td></tr> </table> <hr/><h2>Enumeration Type Documentation</h2> <a class="anchor" id="ab5ff7bcddb7471da0c9f1f0d7dbe038c"></a><!-- doxytag: member="gc_job_manager.h::gc_wait_mode" ref="ab5ff7bcddb7471da0c9f1f0d7dbe038c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="gc__job__manager_8h.html#ab5ff7bcddb7471da0c9f1f0d7dbe038c">gc_wait_mode</a></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="ab5ff7bcddb7471da0c9f1f0d7dbe038ca03e0a1c46214d9006a4078ab88f523be"></a><!-- doxytag: member="GC_WAIT_ANY" ref="ab5ff7bcddb7471da0c9f1f0d7dbe038ca03e0a1c46214d9006a4078ab88f523be" args="" -->GC_WAIT_ANY</em> </td><td> </td></tr> <tr><td valign="top"><em><a class="anchor" id="ab5ff7bcddb7471da0c9f1f0d7dbe038ca1281576bc1c87da9044b2bbbba101963"></a><!-- doxytag: member="GC_WAIT_ALL" ref="ab5ff7bcddb7471da0c9f1f0d7dbe038ca1281576bc1c87da9044b2bbbba101963" args="" -->GC_WAIT_ALL</em> </td><td> </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ad0c489d72a6e526f278f3e2962597ebd"></a><!-- doxytag: member="gc_job_manager.h::gc_job_status_string" ref="ad0c489d72a6e526f278f3e2962597ebd" args="(gc_job_status_t status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::string gc_job_status_string </td> <td>(</td> <td class="paramtype"><a class="el" href="gc__job__desc_8h.html#a8e110a97291b439c37ed61b0931bb0dd">gc_job_status_t</a> </td> <td class="paramname"><em>status</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>map gc_job_status_t into a string </p> </div> </div> <a class="anchor" id="ababcb62055f6ee7f1de4595669e52d2a"></a><!-- doxytag: member="gc_job_manager.h::gc_make_job_manager" ref="ababcb62055f6ee7f1de4595669e52d2a" args="(const gc_jm_options *options=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gc_job_manager_sptr</a> gc_make_job_manager </td> <td>(</td> <td class="paramtype">const <a class="el" href="structgc__jm__options.html">gc_jm_options</a> * </td> <td class="paramname"><em>options</em> = <code>0</code></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a97e12792ec99a2ae9efccb37e309091a"></a><!-- doxytag: member="gc_job_manager.h::gc_program_handle_from_address" ref="a97e12792ec99a2ae9efccb37e309091a" args="(spe_program_handle_t *handle)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a> gc_program_handle_from_address </td> <td>(</td> <td class="paramtype">spe_program_handle_t * </td> <td class="paramname"><em>handle</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Return a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> to an spe_program_handle_t. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">handle</td><td>is a non-zero pointer to an embedded SPE image.</td></tr> </table> </dd> </dl> <p>If successful returns a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> that does nothing when it's time to free the object.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="gc__job__manager_8h.html#a1dd4518136ea1dc7bf0dde42ad7a4803" title="Return a boost::shared_ptr to an spe_program_handle_t.">gc_program_handle_from_filename</a> </dd></dl> </div> </div> <a class="anchor" id="a1dd4518136ea1dc7bf0dde42ad7a4803"></a><!-- doxytag: member="gc_job_manager.h::gc_program_handle_from_filename" ref="a1dd4518136ea1dc7bf0dde42ad7a4803" args="(const std::string &filename)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">spe_program_handle_sptr</a> gc_program_handle_from_filename </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>filename</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Return a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> to an spe_program_handle_t. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">filename</td><td>is the name of the SPE ELF executable to open.</td></tr> </table> </dd> </dl> <p>Calls spe_image_open to open the file. If successful returns a <a class="el" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr</a> that will call spe_image_close when it's time to free the object.</p> <p>Returns the equivalent of the NULL pointer if the file cannot be opened, or if it's not an SPE ELF object file.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="gc__job__manager_8h.html#a97e12792ec99a2ae9efccb37e309091a" title="Return a boost::shared_ptr to an spe_program_handle_t.">gc_program_handle_from_address</a> </dd></dl> </div> </div> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="gc__job__manager_8h.html">gc_job_manager.h</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>