Sophie

Sophie

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

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" kind="class" prot="public">
    <compoundname>mb_runtime</compoundname>
    <derivedcompoundref refid="classmb__runtime__base" prot="public" virt="non-virtual">mb_runtime_base</derivedcompoundref>
    <includes refid="runtime_8h" local="no">runtime.h</includes>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classmb__runtime_1abd8efd53013d2a84b88282a4c770dec0" prot="protected" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">mb_mblock_sptr</ref></type>
        <definition>mb_mblock_sptr mb_runtime::d_top</definition>
        <argsstring></argsstring>
        <name>d_top</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" bodystart="41" bodyend="-1"/>
        <referencedby refid="classmb__runtime_1a8a463ee0ea38c3d82f682cc4a1f07e7f" compoundref="runtime_8h" startline="66" endline="66">top</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classmb__runtime_1a2159f1f7f521a45a87469ffbc91f0f0c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>mb_runtime::mb_runtime</definition>
        <argsstring>()</argsstring>
        <name>mb_runtime</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" line="44" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" bodystart="44" bodyend="44"/>
      </memberdef>
      <memberdef kind="function" id="classmb__runtime_1a15c86150ffac906d49d062541e9961d1" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual mb_runtime::~mb_runtime</definition>
        <argsstring>()</argsstring>
        <name>~mb_runtime</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" line="45"/>
      </memberdef>
      <memberdef kind="function" id="classmb__runtime_1ab197730ccb786c72e00d048b6e9f8122" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>virtual bool mb_runtime::run</definition>
        <argsstring>(const std::string &amp;instance_name, const std::string &amp;class_name, pmt_t user_arg, pmt_t *result=0)=0</argsstring>
        <name>run</name>
        <reimplementedby refid="classmb__runtime__thread__per__block_1a44b1de16c705e362a11ad77fcaa2f885">run</reimplementedby>
        <reimplementedby refid="classmb__runtime__nop_1a720f923c056c9571220152c42be90946">run</reimplementedby>
        <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>
          <defval>0</defval>
        </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/include/mblock/runtime.h" line="63"/>
      </memberdef>
      <memberdef kind="function" id="classmb__runtime_1a8a463ee0ea38c3d82f682cc4a1f07e7f" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">mb_mblock_sptr</ref></type>
        <definition>mb_mblock_sptr mb_runtime::top</definition>
        <argsstring>()</argsstring>
        <name>top</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" line="66" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" bodystart="66" bodyend="66"/>
        <references refid="classmb__runtime_1abd8efd53013d2a84b88282a4c770dec0" compoundref="runtime_8h" startline="41">d_top</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Abstract runtime support for m-blocks. </para>    </briefdescription>
    <detaileddescription>
<para>There should generally be only a single instance of this class. </para>    </detaileddescription>
    <inheritancegraph>
      <node id="13419">
        <label>mb_runtime_nop</label>
        <link refid="classmb__runtime__nop"/>
        <childnode refid="13418" relation="public-inheritance">
        </childnode>
      </node>
      <node id="13418">
        <label>mb_runtime_base</label>
        <link refid="classmb__runtime__base"/>
        <childnode refid="13417" relation="public-inheritance">
        </childnode>
      </node>
      <node id="13417">
        <label>mb_runtime</label>
        <link refid="classmb__runtime"/>
      </node>
      <node id="13420">
        <label>mb_runtime_thread_per_block</label>
        <link refid="classmb__runtime__thread__per__block"/>
        <childnode refid="13418" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="13448">
        <label>T</label>
      </node>
      <node id="13442">
        <label>mb_runtime_base</label>
        <link refid="classmb__runtime__base"/>
        <childnode refid="13421" relation="public-inheritance">
        </childnode>
        <childnode refid="13443" relation="usage">
          <edgelabel>d_accepter</edgelabel>
        </childnode>
        <childnode refid="13441" relation="usage">
          <edgelabel>d_brl</edgelabel>
        </childnode>
      </node>
      <node id="13438">
        <label>boost::shared_ptr&lt; mb_message &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13439" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13446">
        <label>std::map&lt; std::string, mb_port_sptr &gt;</label>
        <childnode refid="13447" relation="usage">
          <edgelabel>elements</edgelabel>
        </childnode>
        <childnode refid="13434" relation="usage">
          <edgelabel>keys</edgelabel>
        </childnode>
      </node>
      <node id="13439">
        <label>mb_message</label>
        <link refid="classmb__message"/>
        <childnode refid="13438" relation="usage">
          <edgelabel>d_next</edgelabel>
        </childnode>
        <childnode refid="13432" relation="usage">
          <edgelabel>d_port_id</edgelabel>
          <edgelabel>d_data</edgelabel>
          <edgelabel>d_metadata</edgelabel>
          <edgelabel>d_signal</edgelabel>
        </childnode>
      </node>
      <node id="13447">
        <label>boost::shared_ptr&lt; T &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13448" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13421">
        <label>mb_runtime</label>
        <link refid="classmb__runtime"/>
        <childnode refid="13422" relation="usage">
          <edgelabel>d_top</edgelabel>
        </childnode>
      </node>
      <node id="13425">
        <label>mb_mblock_impl</label>
        <link refid="classmb__mblock__impl"/>
        <childnode refid="13426" relation="usage">
          <edgelabel>d_conn_table</edgelabel>
        </childnode>
        <childnode refid="13436" relation="usage">
          <edgelabel>d_msgq</edgelabel>
        </childnode>
        <childnode refid="13423" relation="usage">
          <edgelabel>d_mb</edgelabel>
          <edgelabel>d_mb_parent</edgelabel>
        </childnode>
        <childnode refid="13442" relation="usage">
          <edgelabel>d_runtime</edgelabel>
        </childnode>
        <childnode refid="13434" relation="usage">
          <edgelabel>d_class_name</edgelabel>
          <edgelabel>d_instance_name</edgelabel>
        </childnode>
        <childnode refid="13445" relation="usage">
          <edgelabel>d_comp_map</edgelabel>
        </childnode>
        <childnode refid="13446" relation="usage">
          <edgelabel>d_port_map</edgelabel>
        </childnode>
      </node>
      <node id="13431">
        <label>mb_port</label>
        <link refid="classmb__port"/>
        <childnode refid="13423" relation="usage">
          <edgelabel>d_mblock</edgelabel>
        </childnode>
        <childnode refid="13432" relation="usage">
          <edgelabel>d_protocol_class</edgelabel>
          <edgelabel>d_port_symbol</edgelabel>
        </childnode>
        <childnode refid="13434" relation="usage">
          <edgelabel>d_port_name</edgelabel>
        </childnode>
      </node>
      <node id="13422">
        <label>boost::shared_ptr&lt; mb_mblock &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13423" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13429">
        <label>mb_endpoint</label>
        <link refid="classmb__endpoint"/>
        <childnode refid="13430" relation="usage">
          <edgelabel>d_port</edgelabel>
        </childnode>
        <childnode refid="13434" relation="usage">
          <edgelabel>d_component_name</edgelabel>
          <edgelabel>d_port_name</edgelabel>
        </childnode>
      </node>
      <node id="13428">
        <label>mb_connection</label>
        <link refid="structmb__connection"/>
        <childnode refid="13429" relation="usage">
          <edgelabel>d_ep</edgelabel>
        </childnode>
      </node>
      <node id="13435">
        <label>std::basic_string&lt; char &gt;</label>
      </node>
      <node id="13423">
        <label>mb_mblock</label>
        <link refid="classmb__mblock"/>
        <childnode refid="13424" relation="usage">
          <edgelabel>d_impl</edgelabel>
        </childnode>
      </node>
      <node id="13437">
        <label>mb_msg_queue::subq</label>
        <childnode refid="13438" relation="usage">
          <edgelabel>head</edgelabel>
          <edgelabel>tail</edgelabel>
        </childnode>
      </node>
      <node id="13430">
        <label>boost::shared_ptr&lt; mb_port &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13431" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13426">
        <label>mb_conn_table</label>
        <link refid="classmb__conn__table"/>
        <childnode refid="13427" relation="usage">
          <edgelabel>d_connections</edgelabel>
        </childnode>
      </node>
      <node id="13443">
        <label>boost::shared_ptr&lt; mb_msg_accepter &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13444" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13432">
        <label>boost::shared_ptr&lt; pmt_base &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13433" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13433">
        <label>pmt_base</label>
        <link refid="classpmt__base"/>
      </node>
      <node id="13436">
        <label>mb_msg_queue</label>
        <link refid="classmb__msg__queue"/>
        <childnode refid="13437" relation="usage">
          <edgelabel>d_queue</edgelabel>
        </childnode>
        <childnode refid="13440" relation="usage">
          <edgelabel>d_not_empty</edgelabel>
        </childnode>
        <childnode refid="13441" relation="usage">
          <edgelabel>d_mutex</edgelabel>
        </childnode>
      </node>
      <node id="13440">
        <label>omni_condition</label>
        <link refid="classomni__condition"/>
        <childnode refid="13441" relation="usage">
          <edgelabel>mutex</edgelabel>
        </childnode>
      </node>
      <node id="13445">
        <label>std::map&lt; std::string, mb_mblock_sptr &gt;</label>
        <childnode refid="13434" relation="usage">
          <edgelabel>keys</edgelabel>
        </childnode>
      </node>
      <node id="13424">
        <label>boost::shared_ptr&lt; mb_mblock_impl &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="13425" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="13444">
        <label>mb_msg_accepter</label>
        <link refid="classmb__msg__accepter"/>
      </node>
      <node id="13427">
        <label>std::list&lt; mb_connection &gt;</label>
        <childnode refid="13428" relation="usage">
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="13434">
        <label>std::string</label>
        <childnode refid="13435" relation="public-inheritance">
        </childnode>
      </node>
      <node id="13441">
        <label>omni_mutex</label>
        <link refid="classomni__mutex"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" line="39" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/runtime.h" bodystart="37" bodyend="67"/>
    <listofallmembers>
      <member refid="classmb__runtime_1abd8efd53013d2a84b88282a4c770dec0" prot="protected" virt="non-virtual"><scope>mb_runtime</scope><name>d_top</name></member>
      <member refid="classmb__runtime_1a2159f1f7f521a45a87469ffbc91f0f0c" prot="public" virt="non-virtual"><scope>mb_runtime</scope><name>mb_runtime</name></member>
      <member refid="classmb__runtime_1ab197730ccb786c72e00d048b6e9f8122" prot="public" virt="pure-virtual"><scope>mb_runtime</scope><name>run</name></member>
      <member refid="classmb__runtime_1a8a463ee0ea38c3d82f682cc4a1f07e7f" prot="public" virt="non-virtual"><scope>mb_runtime</scope><name>top</name></member>
      <member refid="classmb__runtime_1a15c86150ffac906d49d062541e9961d1" prot="public" virt="virtual"><scope>mb_runtime</scope><name>~mb_runtime</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>