Sophie

Sophie

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

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="classgr__interleave" kind="class" prot="public">
    <compoundname>gr_interleave</compoundname>
    <basecompoundref refid="classgr__sync__interpolator" prot="public" virt="non-virtual">gr_sync_interpolator</basecompoundref>
    <includes refid="gr__interleave_8h" local="no">gr_interleave.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classgr__interleave_1ae3dc040e93b6dda3733632d5e64d4799" prot="private" static="no" mutable="no">
        <type>size_t</type>
        <definition>size_t gr_interleave::d_itemsize</definition>
        <argsstring></argsstring>
        <name>d_itemsize</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" line="41" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" bodystart="41" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classgr__interleave_1a4549e25827e8fdd1e26f3f1339b59773" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend <ref refid="classboost_1_1shared__ptr" kindref="compound">gr_interleave_sptr</ref></type>
        <definition>gr_interleave_sptr gr_make_interleave</definition>
        <argsstring>(size_t itemsize)</argsstring>
        <name>gr_make_interleave</name>
        <param>
          <type>size_t</type>
          <declname>itemsize</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" line="39"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classgr__interleave_1af052fa2b2f5c40ba68a80d957d782375" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_interleave::gr_interleave</definition>
        <argsstring>(size_t itemsize)</argsstring>
        <name>gr_interleave</name>
        <param>
          <type>size_t</type>
          <declname>itemsize</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" line="43"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__interleave_1ae342ba63322b78359ee71de113e41fc1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_interleave::~gr_interleave</definition>
        <argsstring>()</argsstring>
        <name>~gr_interleave</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" line="46"/>
      </memberdef>
      <memberdef kind="function" id="classgr__interleave_1a44664518c86559da58b3feccb9e45d7f" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>int gr_interleave::work</definition>
        <argsstring>(int noutput_items, gr_vector_const_void_star &amp;input_items, gr_vector_void_star &amp;output_items)</argsstring>
        <name>work</name>
        <reimplements refid="classgr__sync__block_1a0c523f4285a6eb690f677ee6295ab117">work</reimplements>
        <param>
          <type>int</type>
          <declname>noutput_items</declname>
        </param>
        <param>
          <type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_const_void_star</ref> &amp;</type>
          <declname>input_items</declname>
        </param>
        <param>
          <type><ref refid="classstd_1_1vector" kindref="compound">gr_vector_void_star</ref> &amp;</type>
          <declname>output_items</declname>
        </param>
        <briefdescription>
<para>just like <ref refid="classgr__block_1a137b93d87dc83bbdb6369d33f4ea8197" kindref="member">gr_block::general_work</ref>, only this arranges to call consume_each for you </para>        </briefdescription>
        <detaileddescription>
<para>The user must override work to define the signal processing code </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" line="50"/>
      </memberdef>
      <memberdef kind="function" id="classgr__interleave_1ade74f196c0fc8a91ca4f853a2d1202e1" 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 gr_interleave::check_topology</definition>
        <argsstring>(int ninputs, int noutputs)</argsstring>
        <name>check_topology</name>
        <reimplements refid="classgr__basic__block_1a50a714df9c3ce8c03854a09ac84e589b">check_topology</reimplements>
        <param>
          <type>int</type>
          <declname>ninputs</declname>
        </param>
        <param>
          <type>int</type>
          <declname>noutputs</declname>
        </param>
        <briefdescription>
<para>Confirm that ninputs and noutputs is an acceptable combination. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ninputs</parametername>
</parameternamelist>
<parameterdescription>
<para>number of input streams connected </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>noutputs</parametername>
</parameternamelist>
<parameterdescription>
<para>number of output streams connected</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>true if this is a valid configuration for this block.</para></simplesect>
This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" line="52"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>interleave N inputs to a single output </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="9755">
        <label>gr_interleave</label>
        <link refid="classgr__interleave"/>
        <childnode refid="9756" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9757">
        <label>gr_sync_block</label>
        <link refid="classgr__sync__block"/>
        <childnode refid="9758" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9758">
        <label>gr_block</label>
        <link refid="classgr__block"/>
        <childnode refid="9759" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9756">
        <label>gr_sync_interpolator</label>
        <link refid="classgr__sync__interpolator"/>
        <childnode refid="9757" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9759">
        <label>gr_basic_block</label>
        <link refid="classgr__basic__block"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="9778">
        <label>std::vector&lt; gr_buffer_reader * &gt;</label>
        <link refid="classstd_1_1vector"/>
        <childnode refid="9774" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="9773">
        <label>boost::shared_ptr&lt; gr_buffer_reader &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="9774" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="9782">
        <label>T</label>
      </node>
      <node id="9760">
        <label>gr_interleave</label>
        <link refid="classgr__interleave"/>
        <childnode refid="9761" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9762">
        <label>gr_sync_block</label>
        <link refid="classgr__sync__block"/>
        <childnode refid="9763" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9774">
        <label>gr_buffer_reader</label>
        <link refid="classgr__buffer__reader"/>
        <childnode refid="9775" relation="usage">
          <edgelabel>d_buffer</edgelabel>
        </childnode>
      </node>
      <node id="9777">
        <label>gr_vmcircbuf</label>
        <link refid="classgr__vmcircbuf"/>
      </node>
      <node id="9763">
        <label>gr_block</label>
        <link refid="classgr__block"/>
        <childnode refid="9764" relation="public-inheritance">
        </childnode>
        <childnode refid="9770" relation="usage">
          <edgelabel>d_detail</edgelabel>
        </childnode>
      </node>
      <node id="9770">
        <label>boost::shared_ptr&lt; gr_block_detail &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="9771" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="9761">
        <label>gr_sync_interpolator</label>
        <link refid="classgr__sync__interpolator"/>
        <childnode refid="9762" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9781">
        <label>boost::shared_ptr&lt; T &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="9782" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="9771">
        <label>gr_block_detail</label>
        <link refid="classgr__block__detail"/>
        <childnode refid="9772" relation="usage">
          <edgelabel>d_input</edgelabel>
        </childnode>
        <childnode refid="9779" relation="usage">
          <edgelabel>d_tpb</edgelabel>
        </childnode>
        <childnode refid="9780" relation="usage">
          <edgelabel>d_output</edgelabel>
        </childnode>
      </node>
      <node id="9765">
        <label>boost::shared_ptr&lt; gr_io_signature &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="9766" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="9776">
        <label>gr_buffer</label>
        <link refid="classgr__buffer"/>
        <childnode refid="9777" relation="usage">
          <edgelabel>d_vmcircbuf</edgelabel>
        </childnode>
        <childnode refid="9778" relation="usage">
          <edgelabel>d_readers</edgelabel>
        </childnode>
      </node>
      <node id="9769">
        <label>std::basic_string&lt; char &gt;</label>
      </node>
      <node id="9772">
        <label>std::vector&lt; gr_buffer_reader_sptr &gt;</label>
        <childnode refid="9773" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="9775">
        <label>boost::shared_ptr&lt; gr_buffer &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="9776" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="9779">
        <label>gr_tpb_detail</label>
        <link refid="structgr__tpb__detail"/>
      </node>
      <node id="9780">
        <label>std::vector&lt; gr_buffer_sptr &gt;</label>
        <childnode refid="9781" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="9766">
        <label>gr_io_signature</label>
        <link refid="classgr__io__signature"/>
        <childnode refid="9767" relation="usage">
          <edgelabel>d_sizeof_stream_item</edgelabel>
        </childnode>
      </node>
      <node id="9764">
        <label>gr_basic_block</label>
        <link refid="classgr__basic__block"/>
        <childnode refid="9765" relation="usage">
          <edgelabel>d_input_signature</edgelabel>
          <edgelabel>d_output_signature</edgelabel>
        </childnode>
        <childnode refid="9768" relation="usage">
          <edgelabel>d_name</edgelabel>
        </childnode>
      </node>
      <node id="9767">
        <label>std::vector&lt; int &gt;</label>
        <link refid="classstd_1_1vector"/>
      </node>
      <node id="9768">
        <label>std::string</label>
        <childnode refid="9769" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" line="38" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/general/gr_interleave.h" bodystart="37" bodyend="54"/>
    <listofallmembers>
      <member refid="classgr__basic__block_1a2503eb6922db0bf2a442dcd2d14670c9" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>basic_block</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da0abd1c82699481ffa502e5bb8d7bdaec" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>BLACK</name></member>
      <member refid="classgr__interleave_1ade74f196c0fc8a91ca4f853a2d1202e1" prot="public" virt="virtual"><scope>gr_interleave</scope><name>check_topology</name></member>
      <member refid="classgr__basic__block_1a1cedb1704b6c00977c681b378ede384c" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>color</name></member>
      <member refid="classgr__block_1ac76b4c53af762a819bca003d5b5cb4d1" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>consume</name></member>
      <member refid="classgr__block_1a64e9a2096975841b72ff3c1662d27df9" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>consume_each</name></member>
      <member refid="classgr__basic__block_1a7fb7e692e3b98a82410b396ef263bb41" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>d_color</name></member>
      <member refid="classgr__basic__block_1a2c8da0c28bbbfb0e759278c9b9459e96" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>d_input_signature</name></member>
      <member refid="classgr__interleave_1ae3dc040e93b6dda3733632d5e64d4799" prot="private" virt="non-virtual"><scope>gr_interleave</scope><name>d_itemsize</name></member>
      <member refid="classgr__basic__block_1afd352cc073ef28012d4d079a863f5401" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>d_name</name></member>
      <member refid="classgr__basic__block_1a76d64ed7a79566e3310306ae6f194d75" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>d_output_signature</name></member>
      <member refid="classgr__basic__block_1a0d2999c04f47327f93dd7def5dc704f8" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>d_unique_id</name></member>
      <member refid="classgr__block_1afb276858409ac55d62fca1c87d7d4083" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>detail</name></member>
      <member refid="classgr__block_1ab4eeb29440f674815ab3b44b4fb0c34d" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>fixed_rate</name></member>
      <member refid="classgr__sync__interpolator_1a943227c6134e71a7867a66977b414533" prot="public" virt="virtual"><scope>gr_interleave</scope><name>fixed_rate_ninput_to_noutput</name></member>
      <member refid="classgr__sync__interpolator_1a03961e37cf520668a87f53762e638b9f" prot="public" virt="virtual"><scope>gr_interleave</scope><name>fixed_rate_noutput_to_ninput</name></member>
      <member refid="classgr__sync__interpolator_1a81ef017ef4ec17d0808cd1c0e2ceb803" prot="public" virt="virtual"><scope>gr_interleave</scope><name>forecast</name></member>
      <member refid="classgr__sync__interpolator_1a49cd2967b214ead14270d97dab932301" prot="public" virt="virtual"><scope>gr_interleave</scope><name>general_work</name></member>
      <member refid="classgr__basic__block_1a1183eee484f58953a2fed4c792e46245" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>gr_basic_block</name></member>
      <member refid="classgr__block_1a268510acce1f94c0a60c5273f4948641" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>gr_block</name></member>
      <member refid="classgr__basic__block_1a69b41e361328cea911d69e1ec0bc50ff" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>gr_flat_flowgraph</name></member>
      <member refid="classgr__basic__block_1adf5bf4523d6dd698aa770e3da8f2b30d" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>gr_flowgraph</name></member>
      <member refid="classgr__interleave_1af052fa2b2f5c40ba68a80d957d782375" prot="private" virt="non-virtual"><scope>gr_interleave</scope><name>gr_interleave</name></member>
      <member refid="classgr__interleave_1a4549e25827e8fdd1e26f3f1339b59773" prot="private" virt="non-virtual"><scope>gr_interleave</scope><name>gr_make_interleave</name></member>
      <member refid="classgr__sync__block_1a832d8dad2dbd38e8e9cfa0b954d37c87" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>gr_sync_block</name></member>
      <member refid="classgr__sync__interpolator_1a0038ee6e80dc446b02ff1caf2556780b" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>gr_sync_interpolator</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3daa6cce7ec34a3f9cf917e545a743dc89f" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>GREY</name></member>
      <member refid="classgr__block_1ad3b305a663f4b5b5c4e17070d00f05d9" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>history</name></member>
      <member refid="classgr__basic__block_1a58f6d05e85931200f3771d3e50741281" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>input_signature</name></member>
      <member refid="classgr__sync__interpolator_1a39beb8a7754295afcc0ff4e5240ceaaf" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>interpolation</name></member>
      <member refid="classgr__basic__block_1aa12a20d8b8eab341da935530d29299d2" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>name</name></member>
      <member refid="classgr__block_1ade8590e9cba9ccfe1b870be46b1416c2" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>output_multiple</name></member>
      <member refid="classgr__basic__block_1add68b96f012dfe352700b4fd1c3a184a" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>output_signature</name></member>
      <member refid="classgr__block_1aa9df8c4d3fb92bde98900831546f8b97" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>relative_rate</name></member>
      <member refid="classgr__basic__block_1a0821ef947158670d53bf0739f3c8877b" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>set_color</name></member>
      <member refid="classgr__block_1a26b61f2c2ca308c3bde82f01d3e9650b" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>set_detail</name></member>
      <member refid="classgr__block_1a176a95343488a9a760c8edf8bb08db20" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>set_fixed_rate</name></member>
      <member refid="classgr__block_1a7c1c85a2d47f72255efd821a6f98f7ba" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>set_history</name></member>
      <member refid="classgr__basic__block_1a419d0fbba0ca02d822cbc299b979de54" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>set_input_signature</name></member>
      <member refid="classgr__sync__interpolator_1a25bb02d6ac26404780bdd217355107ad" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>set_interpolation</name></member>
      <member refid="classgr__block_1a14e8b799f920e52afb93fac413b1a729" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>set_output_multiple</name></member>
      <member refid="classgr__basic__block_1a949b6ad69ebfdf423835265db99cf63d" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>set_output_signature</name></member>
      <member refid="classgr__block_1ab9dc7e6d30692bbfa65fc7c4eef6fc9d" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>set_relative_rate</name></member>
      <member refid="classgr__block_1a49ea94a86f3199f23563bb837633ea1f" prot="public" virt="virtual"><scope>gr_interleave</scope><name>start</name></member>
      <member refid="classgr__block_1a53c2c89c037e4e393b75414d605e36b1" prot="public" virt="virtual"><scope>gr_interleave</scope><name>stop</name></member>
      <member refid="classgr__basic__block_1aa2a2947744d418c5470fbf4e623b58fe" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>unique_id</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3d" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>vcolor</name></member>
      <member refid="classgr__basic__block_1a5c90b7c003ddd61f8df6bef2aceeab3da476d594a077e729bad0f2cfa2008c899" prot="protected" virt="non-virtual"><scope>gr_interleave</scope><name>WHITE</name></member>
      <member refid="classgr__interleave_1a44664518c86559da58b3feccb9e45d7f" prot="public" virt="virtual"><scope>gr_interleave</scope><name>work</name></member>
      <member refid="classgr__basic__block_1a5bc14d27d53b7b57a960a47cc255e3f9" prot="public" virt="virtual"><scope>gr_interleave</scope><name>~gr_basic_block</name></member>
      <member refid="classgr__block_1a19133eeffa5f8e6743342f375551ad0c" prot="public" virt="virtual"><scope>gr_interleave</scope><name>~gr_block</name></member>
      <member refid="classgr__interleave_1ae342ba63322b78359ee71de113e41fc1" prot="public" virt="non-virtual"><scope>gr_interleave</scope><name>~gr_interleave</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>