<?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__buffer__reader" kind="class" prot="public">
    <compoundname>gr_buffer_reader</compoundname>
    <includes refid="gr__buffer_8h" local="no">gr_buffer.h</includes>
      <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classgr__buffer__reader_1aa81c4b34f6e518e11cef52972a9a0c76" prot="public" static="no">
        <type><ref refid="classgr__buffer_1aff98726da27f70ef316640f925636260" kindref="member">gr_buffer::scoped_lock</ref></type>
        <definition>typedef gr_buffer::scoped_lock gr_buffer_reader::scoped_lock</definition>
        <argsstring></argsstring>
        <name>scoped_lock</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="188" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="188" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classgr__buffer__reader_1a25dff068f5cfde18c4307b4973f4db9d" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend class</type>
        <definition>friend class gr_buffer</definition>
        <argsstring></argsstring>
        <name>gr_buffer</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="236" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="236" bodyend="-1"/>
      </memberdef>
      <memberdef kind="friend" id="classgr__buffer__reader_1afb5b9797c2e10e7f5d456643d3b420cb" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend <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)</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>
        </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="238"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classgr__buffer__reader_1aecd7348878a5fa8a7d6e62c6e94d79e8" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_sptr</ref></type>
        <definition>gr_buffer_sptr gr_buffer_reader::d_buffer</definition>
        <argsstring></argsstring>
        <name>d_buffer</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="241" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="241" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__buffer__reader_1ad3707340ac0759f3dc3321550d880a57" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int gr_buffer_reader::d_read_index</definition>
        <argsstring></argsstring>
        <name>d_read_index</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="242" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="242" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__buffer__reader_1a1ec09859229ef50059efe89d844ed900" prot="private" static="no" mutable="no">
        <type>boost::weak_ptr&lt; <ref refid="classgr__block" kindref="compound">gr_block</ref> &gt;</type>
        <definition>boost::weak_ptr&lt;gr_block&gt; gr_buffer_reader::d_link</definition>
        <argsstring></argsstring>
        <name>d_link</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="243" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="243" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__buffer__reader_1a296f93185ddabe97c74ee2bfc1858194" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_buffer_reader::~gr_buffer_reader</definition>
        <argsstring>()</argsstring>
        <name>~gr_buffer_reader</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="190"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1a1ef86082ac536ac95ec469f27d99d6a0" prot="public" static="no" const="yes" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int gr_buffer_reader::items_available</definition>
        <argsstring>() const </argsstring>
        <name>items_available</name>
        <briefdescription>
<para>Return number of items available for reading. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="195"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1aa1f9fc3b86fea8da9cfdb6f693b0d8b1" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_sptr</ref></type>
        <definition>gr_buffer_sptr gr_buffer_reader::buffer</definition>
        <argsstring>() const </argsstring>
        <name>buffer</name>
        <briefdescription>
<para>Return buffer this reader reads from. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="200" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="200" bodyend="200"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1a87ef46cf000ef6168115b8b06cfd0ce8" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type>int</type>
        <definition>int gr_buffer_reader::max_possible_items_available</definition>
        <argsstring>() const </argsstring>
        <name>max_possible_items_available</name>
        <briefdescription>
<para>Return maximum number of items that could ever be available for reading. This is used as a sanity check in the scheduler to avoid looping forever. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="207" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="207" bodyend="207"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1aa0a07401b38ed900cb53e72193233ddf" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>const void *</type>
        <definition>const void* gr_buffer_reader::read_pointer</definition>
        <argsstring>()</argsstring>
        <name>read_pointer</name>
        <briefdescription>
<para>return pointer to read buffer. </para>        </briefdescription>
        <detaileddescription>
<para>The return value points to <ref refid="classgr__buffer__reader_1a1ef86082ac536ac95ec469f27d99d6a0" kindref="member">items_available()</ref> number of items </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="214"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1a6a8e969300be7ffa49811109f27005c4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_buffer_reader::update_read_pointer</definition>
        <argsstring>(int nitems)</argsstring>
        <name>update_read_pointer</name>
        <param>
          <type>int</type>
          <declname>nitems</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="219"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1a8b550f828745a575387ead9701174665" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void gr_buffer_reader::set_done</definition>
        <argsstring>(bool done)</argsstring>
        <name>set_done</name>
        <param>
          <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
          <declname>done</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="221" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="221" bodyend="221"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1a1b0037b814e8576b279fe307c47dd5a5" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool gr_buffer_reader::done</definition>
        <argsstring>() const </argsstring>
        <name>done</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="222" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="222" bodyend="222"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1a789fe0fe9eb7968ab971d848452f3d5c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>boost::mutex *</type>
        <definition>boost::mutex* gr_buffer_reader::mutex</definition>
        <argsstring>()</argsstring>
        <name>mutex</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="224" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="224" bodyend="224"/>
      </memberdef>
      <memberdef kind="function" id="classgr__buffer__reader_1acd78edc8986ecdb3b78a3add8e2ebfde" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref></type>
        <definition>gr_block_sptr gr_buffer_reader::link</definition>
        <argsstring>()</argsstring>
        <name>link</name>
        <briefdescription>
<para>Return the block that reads via this reader. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="230" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="230" bodyend="230"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classgr__buffer__reader_1a36c6888ac35daa5c84be7c1c2505b519" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_buffer_reader::gr_buffer_reader</definition>
        <argsstring>(gr_buffer_sptr buffer, unsigned int read_index, gr_block_sptr link)</argsstring>
        <name>gr_buffer_reader</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_buffer_sptr</ref></type>
          <declname>buffer</declname>
        </param>
        <param>
          <type>unsigned int</type>
          <declname>read_index</declname>
        </param>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">gr_block_sptr</ref></type>
          <declname>link</declname>
        </param>
        <briefdescription>
<para>constructor is private. Use gr_buffer::add_reader to create instances </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="246"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>How we keep track of the readers of a <ref refid="classgr__buffer" kindref="compound">gr_buffer</ref>. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="6802">
        <label>std::vector&lt; gr_buffer_reader * &gt;</label>
        <link refid="classstd_1_1vector"/>
        <childnode refid="6798" relation="usage">
          <edgelabel>p</edgelabel>
          <edgelabel>elements</edgelabel>
        </childnode>
      </node>
      <node id="6798">
        <label>gr_buffer_reader</label>
        <link refid="classgr__buffer__reader"/>
        <childnode refid="6799" relation="usage">
          <edgelabel>d_buffer</edgelabel>
        </childnode>
      </node>
      <node id="6801">
        <label>gr_vmcircbuf</label>
        <link refid="classgr__vmcircbuf"/>
      </node>
      <node id="6800">
        <label>gr_buffer</label>
        <link refid="classgr__buffer"/>
        <childnode refid="6801" relation="usage">
          <edgelabel>d_vmcircbuf</edgelabel>
        </childnode>
        <childnode refid="6802" relation="usage">
          <edgelabel>d_readers</edgelabel>
        </childnode>
      </node>
      <node id="6799">
        <label>boost::shared_ptr&lt; gr_buffer &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="6800" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="185" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="185" bodyend="247"/>
    <listofallmembers>
      <member refid="classgr__buffer__reader_1aa1f9fc3b86fea8da9cfdb6f693b0d8b1" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>buffer</name></member>
      <member refid="classgr__buffer__reader_1aecd7348878a5fa8a7d6e62c6e94d79e8" prot="private" virt="non-virtual"><scope>gr_buffer_reader</scope><name>d_buffer</name></member>
      <member refid="classgr__buffer__reader_1a1ec09859229ef50059efe89d844ed900" prot="private" virt="non-virtual"><scope>gr_buffer_reader</scope><name>d_link</name></member>
      <member refid="classgr__buffer__reader_1ad3707340ac0759f3dc3321550d880a57" prot="private" virt="non-virtual"><scope>gr_buffer_reader</scope><name>d_read_index</name></member>
      <member refid="classgr__buffer__reader_1a1b0037b814e8576b279fe307c47dd5a5" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>done</name></member>
      <member refid="classgr__buffer__reader_1a25dff068f5cfde18c4307b4973f4db9d" prot="private" virt="non-virtual"><scope>gr_buffer_reader</scope><name>gr_buffer</name></member>
      <member refid="classgr__buffer__reader_1afb5b9797c2e10e7f5d456643d3b420cb" prot="private" virt="non-virtual"><scope>gr_buffer_reader</scope><name>gr_buffer_add_reader</name></member>
      <member refid="classgr__buffer__reader_1a36c6888ac35daa5c84be7c1c2505b519" prot="private" virt="non-virtual"><scope>gr_buffer_reader</scope><name>gr_buffer_reader</name></member>
      <member refid="classgr__buffer__reader_1a1ef86082ac536ac95ec469f27d99d6a0" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>items_available</name></member>
      <member refid="classgr__buffer__reader_1acd78edc8986ecdb3b78a3add8e2ebfde" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>link</name></member>
      <member refid="classgr__buffer__reader_1a87ef46cf000ef6168115b8b06cfd0ce8" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>max_possible_items_available</name></member>
      <member refid="classgr__buffer__reader_1a789fe0fe9eb7968ab971d848452f3d5c" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>mutex</name></member>
      <member refid="classgr__buffer__reader_1aa0a07401b38ed900cb53e72193233ddf" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>read_pointer</name></member>
      <member refid="classgr__buffer__reader_1aa81c4b34f6e518e11cef52972a9a0c76" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>scoped_lock</name></member>
      <member refid="classgr__buffer__reader_1a8b550f828745a575387ead9701174665" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>set_done</name></member>
      <member refid="classgr__buffer__reader_1a6a8e969300be7ffa49811109f27005c4" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>update_read_pointer</name></member>
      <member refid="classgr__buffer__reader_1a296f93185ddabe97c74ee2bfc1858194" prot="public" virt="non-virtual"><scope>gr_buffer_reader</scope><name>~gr_buffer_reader</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>