Sophie

Sophie

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

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="classmb__message" kind="class" prot="public">
    <compoundname>mb_message</compoundname>
    <includes refid="message_8h" local="no">message.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classmb__message_1a83acaf4bd033f9eb0b4e291f73a98548" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">mb_message_sptr</ref></type>
        <definition>mb_message_sptr mb_message::d_next</definition>
        <argsstring></argsstring>
        <name>d_next</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="47" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="47" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classmb__message_1ae043e7af6f28e5403959f1e561c2034e" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::d_signal</definition>
        <argsstring></argsstring>
        <name>d_signal</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="48" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classmb__message_1ad0b7246af2a8c47a241d0b54e4259d10" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::d_data</definition>
        <argsstring></argsstring>
        <name>d_data</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="49" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="49" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classmb__message_1a62848b7f1d15a40b14f159be748559b3" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::d_metadata</definition>
        <argsstring></argsstring>
        <name>d_metadata</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="50" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classmb__message_1a653d1bf5fa42293680a2e868f457122f" prot="private" static="no" mutable="no">
        <type><ref refid="common_8h_1aaca6107c0aa97c90bf00d7a0b20c8967" kindref="member">mb_pri_t</ref></type>
        <definition>mb_pri_t mb_message::d_priority</definition>
        <argsstring></argsstring>
        <name>d_priority</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="51" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="51" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classmb__message_1a3a23f8d5563fb28efc8a818f34389cd9" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::d_port_id</definition>
        <argsstring></argsstring>
        <name>d_port_id</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="52" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="52" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classmb__message_1a682d496c07a35ef2e0f7e652ce238c5f" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend class</type>
        <definition>friend class mb_msg_queue</definition>
        <argsstring></argsstring>
        <name>mb_msg_queue</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="54" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="54" bodyend="-1"/>
      </memberdef>
      <memberdef kind="friend" id="classmb__message_1ae4a799d3192b1f59eda195787d3725f7" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend <ref refid="classboost_1_1shared__ptr" kindref="compound">mb_message_sptr</ref></type>
        <definition>mb_message_sptr mb_make_message</definition>
        <argsstring>(pmt_t signal, pmt_t data, pmt_t metadata, mb_pri_t priority)</argsstring>
        <name>mb_make_message</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>signal</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>data</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>metadata</declname>
        </param>
        <param>
          <type><ref refid="common_8h_1aaca6107c0aa97c90bf00d7a0b20c8967" kindref="member">mb_pri_t</ref></type>
          <declname>priority</declname>
        </param>
        <briefdescription>
<para>construct a message and return <ref refid="classboost_1_1shared__ptr" kindref="compound">boost::shared_ptr</ref> </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>signal</parametername>
</parameternamelist>
<parameterdescription>
<para>identifier of the message </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>data</parametername>
</parameternamelist>
<parameterdescription>
<para>the data to be operated on </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>metadata</parametername>
</parameternamelist>
<parameterdescription>
<para>information about the data </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>priority</parametername>
</parameternamelist>
<parameterdescription>
<para>urgency </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="57"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classmb__message_1a3d19c644ec8ff7131d31432fa36de13c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>mb_message::mb_message</definition>
        <argsstring>(pmt_t signal, pmt_t data, pmt_t metadata, mb_pri_t priority)</argsstring>
        <name>mb_message</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>signal</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>data</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>metadata</declname>
        </param>
        <param>
          <type><ref refid="common_8h_1aaca6107c0aa97c90bf00d7a0b20c8967" kindref="member">mb_pri_t</ref></type>
          <declname>priority</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="60"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classmb__message_1a7be7eb5f450f58c224cb57a53b96d07d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>mb_message::~mb_message</definition>
        <argsstring>()</argsstring>
        <name>~mb_message</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="63"/>
      </memberdef>
      <memberdef kind="function" id="classmb__message_1adf399eafd8534483bfabd891799fa7c1" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::signal</definition>
        <argsstring>() const </argsstring>
        <name>signal</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="65" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="65" bodyend="65"/>
      </memberdef>
      <memberdef kind="function" id="classmb__message_1a0ba7b5ed6443e5c14d5718d32e3b8420" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::data</definition>
        <argsstring>() const </argsstring>
        <name>data</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="66" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="66" bodyend="66"/>
      </memberdef>
      <memberdef kind="function" id="classmb__message_1aed19f1c911c2fbe0d6ad1290a0dc8be6" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::metadata</definition>
        <argsstring>() const </argsstring>
        <name>metadata</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="67" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="67" bodyend="67"/>
      </memberdef>
      <memberdef kind="function" id="classmb__message_1ac86731a0308fd9144dfa606e58b48873" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="common_8h_1aaca6107c0aa97c90bf00d7a0b20c8967" kindref="member">mb_pri_t</ref></type>
        <definition>mb_pri_t mb_message::priority</definition>
        <argsstring>() const </argsstring>
        <name>priority</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="68" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="68" bodyend="68"/>
      </memberdef>
      <memberdef kind="function" id="classmb__message_1a0e23a3621d62edbe2bbf6187e1926b1d" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
        <definition>pmt_t mb_message::port_id</definition>
        <argsstring>() const </argsstring>
        <name>port_id</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="69" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="69" bodyend="69"/>
        <referencedby refid="classmb__message_1a6f0f3d212ff6a8945ca4229489681ea3" compoundref="message_8h" startline="71" endline="71">set_port_id</referencedby>
      </memberdef>
      <memberdef kind="function" id="classmb__message_1a6f0f3d212ff6a8945ca4229489681ea3" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void mb_message::set_port_id</definition>
        <argsstring>(pmt_t port_id)</argsstring>
        <name>set_port_id</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">pmt_t</ref></type>
          <declname>port_id</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="71" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="71" bodyend="71"/>
        <references refid="classmb__message_1a0e23a3621d62edbe2bbf6187e1926b1d" compoundref="message_8h" startline="69" endline="69">port_id</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="15065">
        <label>boost::shared_ptr&lt; mb_message &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="15064" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="15064">
        <label>mb_message</label>
        <link refid="classmb__message"/>
        <childnode refid="15065" relation="usage">
          <edgelabel>d_next</edgelabel>
        </childnode>
        <childnode refid="15066" relation="usage">
          <edgelabel>d_port_id</edgelabel>
          <edgelabel>d_data</edgelabel>
          <edgelabel>d_metadata</edgelabel>
          <edgelabel>d_signal</edgelabel>
        </childnode>
      </node>
      <node id="15066">
        <label>boost::shared_ptr&lt; pmt_base &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="15067" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="15067">
        <label>pmt_base</label>
        <link refid="classpmt__base"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" line="46" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/mblock/src/include/mblock/message.h" bodystart="46" bodyend="77"/>
    <listofallmembers>
      <member refid="classmb__message_1ad0b7246af2a8c47a241d0b54e4259d10" prot="private" virt="non-virtual"><scope>mb_message</scope><name>d_data</name></member>
      <member refid="classmb__message_1a62848b7f1d15a40b14f159be748559b3" prot="private" virt="non-virtual"><scope>mb_message</scope><name>d_metadata</name></member>
      <member refid="classmb__message_1a83acaf4bd033f9eb0b4e291f73a98548" prot="private" virt="non-virtual"><scope>mb_message</scope><name>d_next</name></member>
      <member refid="classmb__message_1a3a23f8d5563fb28efc8a818f34389cd9" prot="private" virt="non-virtual"><scope>mb_message</scope><name>d_port_id</name></member>
      <member refid="classmb__message_1a653d1bf5fa42293680a2e868f457122f" prot="private" virt="non-virtual"><scope>mb_message</scope><name>d_priority</name></member>
      <member refid="classmb__message_1ae043e7af6f28e5403959f1e561c2034e" prot="private" virt="non-virtual"><scope>mb_message</scope><name>d_signal</name></member>
      <member refid="classmb__message_1a0ba7b5ed6443e5c14d5718d32e3b8420" prot="public" virt="non-virtual"><scope>mb_message</scope><name>data</name></member>
      <member refid="classmb__message_1ae4a799d3192b1f59eda195787d3725f7" prot="private" virt="non-virtual"><scope>mb_message</scope><name>mb_make_message</name></member>
      <member refid="classmb__message_1a3d19c644ec8ff7131d31432fa36de13c" prot="private" virt="non-virtual"><scope>mb_message</scope><name>mb_message</name></member>
      <member refid="classmb__message_1a682d496c07a35ef2e0f7e652ce238c5f" prot="private" virt="non-virtual"><scope>mb_message</scope><name>mb_msg_queue</name></member>
      <member refid="classmb__message_1aed19f1c911c2fbe0d6ad1290a0dc8be6" prot="public" virt="non-virtual"><scope>mb_message</scope><name>metadata</name></member>
      <member refid="classmb__message_1a0e23a3621d62edbe2bbf6187e1926b1d" prot="public" virt="non-virtual"><scope>mb_message</scope><name>port_id</name></member>
      <member refid="classmb__message_1ac86731a0308fd9144dfa606e58b48873" prot="public" virt="non-virtual"><scope>mb_message</scope><name>priority</name></member>
      <member refid="classmb__message_1a6f0f3d212ff6a8945ca4229489681ea3" prot="public" virt="non-virtual"><scope>mb_message</scope><name>set_port_id</name></member>
      <member refid="classmb__message_1adf399eafd8534483bfabd891799fa7c1" prot="public" virt="non-virtual"><scope>mb_message</scope><name>signal</name></member>
      <member refid="classmb__message_1a7be7eb5f450f58c224cb57a53b96d07d" prot="public" virt="non-virtual"><scope>mb_message</scope><name>~mb_message</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>