Sophie

Sophie

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

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="gr__buffer_8h" kind="file">
    <compoundname>gr_buffer.h</compoundname>
    <includes refid="gr__runtime__types_8h" local="no">gr_runtime_types.h</includes>
    <includes local="no">boost/weak_ptr.hpp</includes>
    <includes local="no">boost/thread.hpp</includes>
    <incdepgraph>
      <node id="3991">
        <label>boost/shared_ptr.hpp</label>
      </node>
      <node id="3988">
        <label>gr_buffer.h</label>
        <link refid="gr_buffer.h"/>
        <childnode refid="3989" relation="include">
        </childnode>
        <childnode refid="3996" relation="include">
        </childnode>
        <childnode refid="3997" relation="include">
        </childnode>
      </node>
      <node id="3990">
        <label>gr_types.h</label>
        <link refid="gr__types_8h"/>
        <childnode refid="3991" relation="include">
        </childnode>
        <childnode refid="3992" relation="include">
        </childnode>
        <childnode refid="3993" relation="include">
        </childnode>
        <childnode refid="3994" relation="include">
        </childnode>
      </node>
      <node id="3996">
        <label>boost/weak_ptr.hpp</label>
      </node>
      <node id="3997">
        <label>boost/thread.hpp</label>
      </node>
      <node id="3993">
        <label>stddef.h</label>
      </node>
      <node id="3992">
        <label>vector</label>
      </node>
      <node id="3994">
        <label>gr_complex.h</label>
        <link refid="gr__complex_8h"/>
        <childnode refid="3995" relation="include">
        </childnode>
      </node>
      <node id="3989">
        <label>gr_runtime_types.h</label>
        <link refid="gr__runtime__types_8h"/>
        <childnode refid="3990" relation="include">
        </childnode>
      </node>
      <node id="3995">
        <label>complex</label>
      </node>
    </incdepgraph>
    <innerclass refid="classgr__buffer" prot="public">gr_buffer</innerclass>
    <innerclass refid="classgr__buffer__reader" prot="public">gr_buffer_reader</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="gr__buffer_8h_1aebc8f592465e520011dc5eb872b1a5e7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_sptr</ref></type>
        <definition>gr_buffer_sptr gr_make_buffer</definition>
        <argsstring>(int nitems, size_t sizeof_item, gr_block_sptr link=gr_block_sptr())</argsstring>
        <name>gr_make_buffer</name>
        <param>
          <type>int</type>
          <declname>nitems</declname>
        </param>
        <param>
          <type>size_t</type>
          <declname>sizeof_item</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref></type>
          <declname>link</declname>
          <defval><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref>()</defval>
        </param>
        <briefdescription>
<para>Allocate a buffer that holds at least <computeroutput>nitems</computeroutput> of size <computeroutput>sizeof_item</computeroutput>. </para>        </briefdescription>
        <detaileddescription>
<para>The total size of the buffer will be rounded up to a system dependent boundary. This is typically the system page size, but under MS windows is 64KB.</para><para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>nitems</parametername>
</parameternamelist>
<parameterdescription>
<para>is the minimum number of items the buffer will hold. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>sizeof_item</parametername>
</parameternamelist>
<parameterdescription>
<para>is the size of an item in bytes. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>link</parametername>
</parameternamelist>
<parameterdescription>
<para>is the block that writes to this buffer. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="43"/>
      </memberdef>
      <memberdef kind="function" id="gr__buffer_8h_1aa5e3f8c5b81a3b5395efb545e5b56613" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_reader_sptr</ref></type>
        <definition>gr_buffer_reader_sptr gr_buffer_add_reader</definition>
        <argsstring>(gr_buffer_sptr buf, int nzero_preload, gr_block_sptr link=gr_block_sptr())</argsstring>
        <name>gr_buffer_add_reader</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_sptr</ref></type>
          <declname>buf</declname>
        </param>
        <param>
          <type>int</type>
          <declname>nzero_preload</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref></type>
          <declname>link</declname>
          <defval><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref>()</defval>
        </param>
        <briefdescription>
<para>Create a new <ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref> and attach it to buffer <computeroutput>buf</computeroutput>. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>buf</parametername>
</parameternamelist>
<parameterdescription>
<para>is the buffer the <computeroutput><ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref></computeroutput> reads from. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>nzero_preload</parametername>
</parameternamelist>
<parameterdescription>
<para>-- number of zero items to &quot;preload&quot; into buffer. </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>link</parametername>
</parameternamelist>
<parameterdescription>
<para>is the block that reads from the buffer using this <ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref>. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="172"/>
      </memberdef>
      <memberdef kind="function" id="gr__buffer_8h_1aa863a94ed8f87b2603df59e7b0eeed37" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>long</type>
        <definition>long gr_buffer_ncurrently_allocated</definition>
        <argsstring>()</argsstring>
        <name>gr_buffer_ncurrently_allocated</name>
        <briefdescription>
<para>returns # of gr_buffers currently allocated </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="175"/>
      </memberdef>
      <memberdef kind="function" id="gr__buffer_8h_1a229e8245902aa53c7fe9644c2fc6f3a9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>long</type>
        <definition>long gr_buffer_reader_ncurrently_allocated</definition>
        <argsstring>()</argsstring>
        <name>gr_buffer_reader_ncurrently_allocated</name>
        <briefdescription>
<para>returns # of gr_buffer_readers currently allocated </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="250"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h"/>
  </compounddef>
</doxygen>