Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 8289

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
  <compounddef id="gc__job__manager_8h" kind="file">
    <compoundname>gc_job_manager.h</compoundname>
    <includes local="no">boost/utility.hpp</includes>
    <includes local="no">boost/shared_ptr.hpp</includes>
    <includes local="no">vector</includes>
    <includes local="no">string</includes>
    <includes local="no">stdexcept</includes>
    <includes local="no">libspe2.h</includes>
    <includes refid="gc__job__desc_8h" local="yes">gc_job_desc.h</includes>
    <incdepgraph>
      <node id="3757">
        <label>boost/shared_ptr.hpp</label>
      </node>
      <node id="3755">
        <label>gc_job_manager.h</label>
        <link refid="gc_job_manager.h"/>
        <childnode refid="3756" relation="include">
        </childnode>
        <childnode refid="3757" relation="include">
        </childnode>
        <childnode refid="3758" relation="include">
        </childnode>
        <childnode refid="3759" relation="include">
        </childnode>
        <childnode refid="3760" relation="include">
        </childnode>
        <childnode refid="3761" relation="include">
        </childnode>
        <childnode refid="3762" relation="include">
        </childnode>
      </node>
      <node id="3760">
        <label>stdexcept</label>
      </node>
      <node id="3759">
        <label>string</label>
      </node>
      <node id="3764">
        <label>gcell/gc_job_desc_private.h</label>
      </node>
      <node id="3758">
        <label>vector</label>
      </node>
      <node id="3756">
        <label>boost/utility.hpp</label>
      </node>
      <node id="3763">
        <label>gcell/gc_types.h</label>
      </node>
      <node id="3762">
        <label>gc_job_desc.h</label>
        <link refid="gc__job__desc_8h"/>
        <childnode refid="3763" relation="include">
        </childnode>
        <childnode refid="3764" relation="include">
        </childnode>
      </node>
      <node id="3761">
        <label>libspe2.h</label>
      </node>
    </incdepgraph>
    <innerclass refid="structgc__jm__options" prot="public">gc_jm_options</innerclass>
    <innerclass refid="classgc__exception" prot="public">gc_exception</innerclass>
    <innerclass refid="classgc__unknown__proc" prot="public">gc_unknown_proc</innerclass>
    <innerclass refid="classgc__bad__alloc" prot="public">gc_bad_alloc</innerclass>
    <innerclass refid="classgc__bad__align" prot="public">gc_bad_align</innerclass>
    <innerclass refid="classgc__bad__submit" prot="public">gc_bad_submit</innerclass>
    <innerclass refid="classgc__job__manager" prot="public">gc_job_manager</innerclass>
      <sectiondef kind="enum">
      <memberdef kind="enum" id="gc__job__manager_8h_1ab5ff7bcddb7471da0c9f1f0d7dbe038c" prot="public" static="no">
        <name>gc_wait_mode</name>
        <enumvalue id="gc__job__manager_8h_1ab5ff7bcddb7471da0c9f1f0d7dbe038ca03e0a1c46214d9006a4078ab88f523be" prot="public">
          <name>GC_WAIT_ANY</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__manager_8h_1ab5ff7bcddb7471da0c9f1f0d7dbe038ca1281576bc1c87da9044b2bbbba101963" prot="public">
          <name>GC_WAIT_ALL</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="105" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" bodystart="105" bodyend="108"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="gc__job__manager_8h_1a1dd4518136ea1dc7bf0dde42ad7a4803" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">spe_program_handle_sptr</ref></type>
        <definition>spe_program_handle_sptr gc_program_handle_from_filename</definition>
        <argsstring>(const std::string &amp;filename)</argsstring>
        <name>gc_program_handle_from_filename</name>
        <param>
          <type>const std::string &amp;</type>
          <declname>filename</declname>
        </param>
        <briefdescription>
<para>Return a <ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref> to an spe_program_handle_t. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>filename</parametername>
</parameternamelist>
<parameterdescription>
<para>is the name of the SPE ELF executable to open.</para></parameterdescription>
</parameteritem>
</parameterlist>
Calls spe_image_open to open the file. If successful returns a <ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref> that will call spe_image_close when it&apos;s time to free the object.</para><para>Returns the equivalent of the NULL pointer if the file cannot be opened, or if it&apos;s not an SPE ELF object file.</para><para><simplesect kind="see"><para><ref refid="gc__job__manager_8h_1a97e12792ec99a2ae9efccb37e309091a" kindref="member">gc_program_handle_from_address</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="53"/>
      </memberdef>
      <memberdef kind="function" id="gc__job__manager_8h_1a97e12792ec99a2ae9efccb37e309091a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">spe_program_handle_sptr</ref></type>
        <definition>spe_program_handle_sptr gc_program_handle_from_address</definition>
        <argsstring>(spe_program_handle_t *handle)</argsstring>
        <name>gc_program_handle_from_address</name>
        <param>
          <type>spe_program_handle_t *</type>
          <declname>handle</declname>
        </param>
        <briefdescription>
<para>Return a <ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref> to an spe_program_handle_t. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>handle</parametername>
</parameternamelist>
<parameterdescription>
<para>is a non-zero pointer to an embedded SPE image.</para></parameterdescription>
</parameteritem>
</parameterlist>
If successful returns a <ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref> that does nothing when it&apos;s time to free the object.</para><para><simplesect kind="see"><para><ref refid="gc__job__manager_8h_1a1dd4518136ea1dc7bf0dde42ad7a4803" kindref="member">gc_program_handle_from_filename</ref> </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="66"/>
      </memberdef>
      <memberdef kind="function" id="gc__job__manager_8h_1ad0c489d72a6e526f278f3e2962597ebd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>const std::string</type>
        <definition>const std::string gc_job_status_string</definition>
        <argsstring>(gc_job_status_t status)</argsstring>
        <name>gc_job_status_string</name>
        <param>
          <type><ref refid="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dd" kindref="member">gc_job_status_t</ref></type>
          <declname>status</declname>
        </param>
        <briefdescription>
<para>map gc_job_status_t into a string </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="72"/>
      </memberdef>
      <memberdef kind="function" id="gc__job__manager_8h_1ababcb62055f6ee7f1de4595669e52d2a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gc_job_manager_sptr</ref></type>
        <definition>gc_job_manager_sptr gc_make_job_manager</definition>
        <argsstring>(const gc_jm_options *options=0)</argsstring>
        <name>gc_make_job_manager</name>
        <param>
          <type>const <ref refid="structgc__jm__options" kindref="compound">gc_jm_options</ref> *</type>
          <declname>options</declname>
          <defval>0</defval>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h" line="147"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_manager.h"/>
  </compounddef>
</doxygen>