Sophie

Sophie

distrib > Fedora > 13 > x86_64 > by-pkgid > ae19f57cd4e306abd5716199a310070b > files > 8036

gnuradio-doc-3.2.2-3.fc13.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.6.2">
  <compounddef id="classmb__runtime__nop" kind="class" prot="public">
    <compoundname>mb_runtime_nop</compoundname>
    <basecompoundref refid="classmb__runtime__base" prot="public" virt="non-virtual">mb_runtime_base</basecompoundref>
    <includes refid="mb__runtime__nop_8h" local="no">mb_runtime_nop.h</includes>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classmb__runtime__nop_1a53e7a83f6c429fdc5e4f7857528a4331" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>mb_runtime_nop::mb_runtime_nop</definition>
        <argsstring>()</argsstring>
        <name>mb_runtime_nop</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/lib/mb_runtime_nop.h" line="37"/>
      </memberdef>
      <memberdef kind="function" id="classmb__runtime__nop_1a6361afa8dd3e35ad8eaf43f3e479e0f6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>mb_runtime_nop::~mb_runtime_nop</definition>
        <argsstring>()</argsstring>
        <name>~mb_runtime_nop</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/lib/mb_runtime_nop.h" line="38"/>
      </memberdef>
      <memberdef kind="function" id="classmb__runtime__nop_1a720f923c056c9571220152c42be90946" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool mb_runtime_nop::run</definition>
        <argsstring>(const std::string &amp;instance_name, const std::string &amp;class_name, pmt_t user_arg, pmt_t *result)</argsstring>
        <name>run</name>
        <reimplements refid="classmb__runtime_1ab197730ccb786c72e00d048b6e9f8122">run</reimplements>
        <param>
          <type>const std::string &amp;</type>
          <declname>instance_name</declname>
        </param>
        <param>
          <type>const std::string &amp;</type>
          <declname>class_name</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>user_arg</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref> *</type>
          <declname>result</declname>
        </param>
        <briefdescription>
<para>Construct and run the specified mblock hierarchy. </para>        </briefdescription>
        <detaileddescription>
<para>This routine turns into the m-block scheduler, and blocks until the system is shutdown.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>instance_name</parametername>
</parameternamelist>
<parameterdescription>
<para>name of the top-level mblock (conventionally &quot;top&quot;) </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>class_name</parametername>
</parameternamelist>
<parameterdescription>
<para>The class of the top-level mblock to create. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>user_arg</parametername>
</parameternamelist>
<parameterdescription>
<para>The argument to pass to the top-level mblock constructor </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>result</parametername>
</parameternamelist>
<parameterdescription>
<para>The value passed to shutdown_all.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>true if the system ran successfully. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/lib/mb_runtime_nop.h" line="43"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-func">
      <memberdef kind="function" id="classmb__runtime__nop_1a61e1865ac23b9d049622fe56113d5474" prot="protected" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">mb_mblock_sptr</ref></type>
        <definition>mb_mblock_sptr mb_runtime_nop::create_component</definition>
        <argsstring>(const std::string &amp;instance_name, const std::string &amp;class_name, pmt_t user_arg)</argsstring>
        <name>create_component</name>
        <reimplements refid="classmb__runtime__base_1a0ae17910d65487595d86168fd55c18b2">create_component</reimplements>
        <param>
          <type>const std::string &amp;</type>
          <declname>instance_name</declname>
        </param>
        <param>
          <type>const std::string &amp;</type>
          <declname>class_name</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>user_arg</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/lib/mb_runtime_nop.h" line="49"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Concrete runtime that does nothing. Used only during early QA tests. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="13481">
        <label>mb_runtime_nop</label>
        <link refid="classmb__runtime__nop"/>
        <childnode refid="13482" relation="public-inheritance">
        </childnode>
      </node>
      <node id="13482">
        <label>mb_runtime_base</label>
        <link refid="classmb__runtime__base"/>
        <childnode refid="13483" relation="public-inheritance">
        </childnode>
      </node>
      <node id="13483">
        <label>mb_runtime</label>
        <link refid="classmb__runtime"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="13484">
        <label>mb_runtime_nop</label>
        <link refid="classmb__runtime__nop"/>
        <childnode refid="13485" relation="public-inheritance">
        </childnode>
      </node>
      <node id="13510">
        <label>T</label>
      </node>
      <node id="13485">
        <label>mb_runtime_base</label>
        <link refid="classmb__runtime__base"/>
        <childnode refid="13486" relation="public-inheritance">
        </childnode>
        <childnode refid="13511" relation="usage">
          <edgelabel>d_accepter</edgelabel>
        </childnode>
        <childnode refid="13506" relation="usage">
          <edgelabel>d_brl</edgelabel>
        </childnode>
      </node>
      <node id="13503">
        <label>boost::shared_ptr&lt; mb_message &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13504" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13508">
        <label>std::map&lt; std::string, mb_port_sptr &gt;</label>
        <childnode refid="13509" relation="usage">
          <edgelabel>elements</edgelabel>
        </childnode>
        <childnode refid="13499" relation="usage">
          <edgelabel>keys</edgelabel>
        </childnode>
      </node>
      <node id="13504">
        <label>mb_message</label>
        <link refid="classmb__message"/>
        <childnode refid="13503" relation="usage">
          <edgelabel>d_next</edgelabel>
        </childnode>
        <childnode refid="13497" relation="usage">
          <edgelabel>d_port_id</edgelabel>
          <edgelabel>d_data</edgelabel>
          <edgelabel>d_metadata</edgelabel>
          <edgelabel>d_signal</edgelabel>
        </childnode>
      </node>
      <node id="13509">
        <label>boost::shared_ptr&lt; T &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13510" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13486">
        <label>mb_runtime</label>
        <link refid="classmb__runtime"/>
        <childnode refid="13487" relation="usage">
          <edgelabel>d_top</edgelabel>
        </childnode>
      </node>
      <node id="13490">
        <label>mb_mblock_impl</label>
        <link refid="classmb__mblock__impl"/>
        <childnode refid="13491" relation="usage">
          <edgelabel>d_conn_table</edgelabel>
        </childnode>
        <childnode refid="13501" relation="usage">
          <edgelabel>d_msgq</edgelabel>
        </childnode>
        <childnode refid="13488" relation="usage">
          <edgelabel>d_mb</edgelabel>
          <edgelabel>d_mb_parent</edgelabel>
        </childnode>
        <childnode refid="13485" relation="usage">
          <edgelabel>d_runtime</edgelabel>
        </childnode>
        <childnode refid="13499" relation="usage">
          <edgelabel>d_class_name</edgelabel>
          <edgelabel>d_instance_name</edgelabel>
        </childnode>
        <childnode refid="13507" relation="usage">
          <edgelabel>d_comp_map</edgelabel>
        </childnode>
        <childnode refid="13508" relation="usage">
          <edgelabel>d_port_map</edgelabel>
        </childnode>
      </node>
      <node id="13496">
        <label>mb_port</label>
        <link refid="classmb__port"/>
        <childnode refid="13488" relation="usage">
          <edgelabel>d_mblock</edgelabel>
        </childnode>
        <childnode refid="13497" relation="usage">
          <edgelabel>d_protocol_class</edgelabel>
          <edgelabel>d_port_symbol</edgelabel>
        </childnode>
        <childnode refid="13499" relation="usage">
          <edgelabel>d_port_name</edgelabel>
        </childnode>
      </node>
      <node id="13487">
        <label>boost::shared_ptr&lt; mb_mblock &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13488" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13494">
        <label>mb_endpoint</label>
        <link refid="classmb__endpoint"/>
        <childnode refid="13495" relation="usage">
          <edgelabel>d_port</edgelabel>
        </childnode>
        <childnode refid="13499" relation="usage">
          <edgelabel>d_component_name</edgelabel>
          <edgelabel>d_port_name</edgelabel>
        </childnode>
      </node>
      <node id="13493">
        <label>mb_connection</label>
        <link refid="structmb__connection"/>
        <childnode refid="13494" relation="usage">
          <edgelabel>d_ep</edgelabel>
        </childnode>
      </node>
      <node id="13500">
        <label>std::basic_string&lt; char &gt;</label>
      </node>
      <node id="13488">
        <label>mb_mblock</label>
        <link refid="classmb__mblock"/>
        <childnode refid="13489" relation="usage">
          <edgelabel>d_impl</edgelabel>
        </childnode>
      </node>
      <node id="13502">
        <label>mb_msg_queue::subq</label>
        <childnode refid="13503" relation="usage">
          <edgelabel>head</edgelabel>
          <edgelabel>tail</edgelabel>
        </childnode>
      </node>
      <node id="13495">
        <label>boost::shared_ptr&lt; mb_port &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13496" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13491">
        <label>mb_conn_table</label>
        <link refid="classmb__conn__table"/>
        <childnode refid="13492" relation="usage">
          <edgelabel>d_connections</edgelabel>
        </childnode>
      </node>
      <node id="13511">
        <label>boost::shared_ptr&lt; mb_msg_accepter &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13512" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13497">
        <label>boost::shared_ptr&lt; pmt_base &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13498" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13498">
        <label>pmt_base</label>
        <link refid="classpmt__base"/>
      </node>
      <node id="13501">
        <label>mb_msg_queue</label>
        <link refid="classmb__msg__queue"/>
        <childnode refid="13502" relation="usage">
          <edgelabel>d_queue</edgelabel>
        </childnode>
        <childnode refid="13505" relation="usage">
          <edgelabel>d_not_empty</edgelabel>
        </childnode>
        <childnode refid="13506" relation="usage">
          <edgelabel>d_mutex</edgelabel>
        </childnode>
      </node>
      <node id="13505">
        <label>omni_condition</label>
        <link refid="classomni__condition"/>
        <childnode refid="13506" relation="usage">
          <edgelabel>mutex</edgelabel>
        </childnode>
      </node>
      <node id="13507">
        <label>std::map&lt; std::string, mb_mblock_sptr &gt;</label>
        <childnode refid="13499" relation="usage">
          <edgelabel>keys</edgelabel>
        </childnode>
      </node>
      <node id="13489">
        <label>boost::shared_ptr&lt; mb_mblock_impl &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13490" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13512">
        <label>mb_msg_accepter</label>
        <link refid="classmb__msg__accepter"/>
      </node>
      <node id="13492">
        <label>std::list&lt; mb_connection &gt;</label>
        <childnode refid="13493" relation="usage">
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="13499">
        <label>std::string</label>
        <childnode refid="13500" relation="public-inheritance">
        </childnode>
      </node>
      <node id="13506">
        <label>omni_mutex</label>
        <link refid="classomni__mutex"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/lib/mb_runtime_nop.h" line="35" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/lib/mb_runtime_nop.h" bodystart="34" bodyend="50"/>
    <listofallmembers>
      <member refid="classmb__runtime__base_1ab3173c15358d80fbf11d6e4d950ddacb" prot="public" virt="non-virtual"><scope>mb_runtime_nop</scope><name>accepter</name></member>
      <member refid="classmb__runtime__base_1abbdf8542365e88cc9c0dc4d78d8d5380" prot="public" virt="virtual"><scope>mb_runtime_nop</scope><name>cancel_timeout</name></member>
      <member refid="classmb__runtime__nop_1a61e1865ac23b9d049622fe56113d5474" prot="protected" virt="virtual"><scope>mb_runtime_nop</scope><name>create_component</name></member>
      <member refid="classmb__runtime__base_1a700f4ec2bca9fb83368e3dfaafc57464" prot="protected" virt="non-virtual"><scope>mb_runtime_nop</scope><name>d_accepter</name></member>
      <member refid="classmb__runtime_1abd8efd53013d2a84b88282a4c770dec0" prot="protected" virt="non-virtual"><scope>mb_runtime_nop</scope><name>d_top</name></member>
      <member refid="classmb__runtime__base_1ac9944a6774ab7ba81eca59d1ea0e673f" prot="public" virt="non-virtual"><scope>mb_runtime_nop</scope><name>lock</name></member>
      <member refid="classmb__runtime_1a2159f1f7f521a45a87469ffbc91f0f0c" prot="public" virt="non-virtual"><scope>mb_runtime_nop</scope><name>mb_runtime</name></member>
      <member refid="classmb__runtime__nop_1a53e7a83f6c429fdc5e4f7857528a4331" prot="public" virt="non-virtual"><scope>mb_runtime_nop</scope><name>mb_runtime_nop</name></member>
      <member refid="classmb__runtime__base_1acfefe1d5c599a0737cd396d078e16a57" prot="public" virt="virtual"><scope>mb_runtime_nop</scope><name>request_shutdown</name></member>
      <member refid="classmb__runtime__nop_1a720f923c056c9571220152c42be90946" prot="public" virt="virtual"><scope>mb_runtime_nop</scope><name>run</name></member>
      <member refid="classmb__runtime__base_1af8821d8647adc7514f996132a0ff7851" prot="public" virt="virtual"><scope>mb_runtime_nop</scope><name>schedule_one_shot_timeout</name></member>
      <member refid="classmb__runtime__base_1a149a0b4c01ce681ce1e548380c467140" prot="public" virt="virtual"><scope>mb_runtime_nop</scope><name>schedule_periodic_timeout</name></member>
      <member refid="classmb__runtime_1a8a463ee0ea38c3d82f682cc4a1f07e7f" prot="public" virt="non-virtual"><scope>mb_runtime_nop</scope><name>top</name></member>
      <member refid="classmb__runtime__base_1abb6d8310dfeec507938fef91425a963a" prot="public" virt="non-virtual"><scope>mb_runtime_nop</scope><name>unlock</name></member>
      <member refid="classmb__runtime_1a15c86150ffac906d49d062541e9961d1" prot="public" virt="virtual"><scope>mb_runtime_nop</scope><name>~mb_runtime</name></member>
      <member refid="classmb__runtime__nop_1a6361afa8dd3e35ad8eaf43f3e479e0f6" prot="public" virt="non-virtual"><scope>mb_runtime_nop</scope><name>~mb_runtime_nop</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>