<?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" kind="class" prot="public">
<compoundname>gr_buffer</compoundname>
<includes refid="gr__buffer_8h" local="no">gr_buffer.h</includes>
<sectiondef kind="public-type">
<memberdef kind="typedef" id="classgr__buffer_1aff98726da27f70ef316640f925636260" prot="public" static="no">
<type>boost::unique_lock< boost::mutex ></type>
<definition>typedef boost::unique_lock<boost::mutex> gr_buffer::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="53" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="53" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="friend">
<memberdef kind="friend" id="classgr__buffer_1a7ecfad759b1fdf2dcb7416a16f563482" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>friend class</type>
<definition>friend class 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="97" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="97" bodyend="-1"/>
</memberdef>
<memberdef kind="friend" id="classgr__buffer_1a9c3543ee3c4e4eea1d8ea5c3705ecdbf" 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_sptr</ref></type>
<definition>gr_buffer_sptr gr_make_buffer</definition>
<argsstring>(int nitems, size_t sizeof_item, gr_block_sptr link)</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>
</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="98"/>
</memberdef>
<memberdef kind="friend" id="classgr__buffer_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 "preload" 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="99"/>
</memberdef>
</sectiondef>
<sectiondef kind="protected-attrib">
<memberdef kind="variable" id="classgr__buffer_1a60aa2c93de67e9c5782a34130aac8da3" prot="protected" static="no" mutable="no">
<type>char *</type>
<definition>char* gr_buffer::d_base</definition>
<argsstring></argsstring>
<name>d_base</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="102" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="102" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__buffer_1a2ce1b319068ce94e4799b7affe4b48ae" prot="protected" static="no" mutable="no">
<type>unsigned int</type>
<definition>unsigned int gr_buffer::d_bufsize</definition>
<argsstring></argsstring>
<name>d_bufsize</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="103" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="103" bodyend="-1"/>
<referencedby refid="classgr__buffer_1a39a2c75577d0b37f7eef0b930d588da4" compoundref="gr__buffer_8h" startline="65" endline="65">bufsize</referencedby>
</memberdef>
</sectiondef>
<sectiondef kind="private-attrib">
<memberdef kind="variable" id="classgr__buffer_1a1f4a14166f2750055fce78f19668f507" prot="private" static="no" mutable="no">
<type><ref refid="classgr__vmcircbuf" kindref="compound">gr_vmcircbuf</ref> *</type>
<definition>gr_vmcircbuf* gr_buffer::d_vmcircbuf</definition>
<argsstring></argsstring>
<name>d_vmcircbuf</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="105" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="105" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__buffer_1ab1456289193ea99bb03e9a683b6320aa" prot="private" static="no" mutable="no">
<type>size_t</type>
<definition>size_t gr_buffer::d_sizeof_item</definition>
<argsstring></argsstring>
<name>d_sizeof_item</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="106" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="106" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__buffer_1a07555097fda9bd99e23fd8649971bf7d" prot="private" static="no" mutable="no">
<type><ref refid="classstd_1_1vector" kindref="compound">std::vector</ref>< <ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref> * ></type>
<definition>std::vector<gr_buffer_reader *> gr_buffer::d_readers</definition>
<argsstring></argsstring>
<name>d_readers</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="107" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="107" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__buffer_1aadfe3072e4aa511b0a20b9d5769817fb" prot="private" static="no" mutable="no">
<type>boost::weak_ptr< <ref refid="classgr__block" kindref="compound">gr_block</ref> ></type>
<definition>boost::weak_ptr<gr_block> gr_buffer::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="108" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="108" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__buffer_1acbeb7c22848ee841ae26443a5a949bc4" prot="private" static="no" mutable="no">
<type>boost::mutex</type>
<definition>boost::mutex gr_buffer::d_mutex</definition>
<argsstring></argsstring>
<name>d_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="113" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="113" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__buffer_1a25bae292c516aaac0b39b8cf6eb7db7e" prot="private" static="no" mutable="no">
<type>unsigned int</type>
<definition>unsigned int gr_buffer::d_write_index</definition>
<argsstring></argsstring>
<name>d_write_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="114" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="114" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="classgr__buffer_1ac0aa4692972c778d6eabadab3c006982" prot="private" static="no" mutable="no">
<type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
<definition>bool gr_buffer::d_done</definition>
<argsstring></argsstring>
<name>d_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="115" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="115" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
<memberdef kind="function" id="classgr__buffer_1ab3c5c8028b30a30c6c3eb3015225ba4b" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type></type>
<definition>virtual gr_buffer::~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="55"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a1d064236bb139c339a425b51212813b1" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>int</type>
<definition>int gr_buffer::space_available</definition>
<argsstring>()</argsstring>
<name>space_available</name>
<briefdescription>
<para>return number of items worth of space available for writing </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="60"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a39a2c75577d0b37f7eef0b930d588da4" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
<type>int</type>
<definition>int gr_buffer::bufsize</definition>
<argsstring>() const </argsstring>
<name>bufsize</name>
<briefdescription>
<para>return size of this buffer in items </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="65" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="65" bodyend="65"/>
<references refid="classgr__buffer_1a2ce1b319068ce94e4799b7affe4b48ae" compoundref="gr__buffer_8h" startline="103">d_bufsize</references>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a1a4dc904e4da49e58a3405550665a712" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void *</type>
<definition>void* gr_buffer::write_pointer</definition>
<argsstring>()</argsstring>
<name>write_pointer</name>
<briefdescription>
<para>return pointer to write buffer. </para> </briefdescription>
<detaileddescription>
<para>The return value points at space that can hold at least <ref refid="classgr__buffer_1a1d064236bb139c339a425b51212813b1" kindref="member">space_available()</ref> items. </para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="73"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1aba102b9c8394068b2c4b570c0e788e82" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void gr_buffer::update_write_pointer</definition>
<argsstring>(int nitems)</argsstring>
<name>update_write_pointer</name>
<param>
<type>int</type>
<declname>nitems</declname>
</param>
<briefdescription>
<para>tell buffer that we wrote <computeroutput>nitems</computeroutput> into it </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="78"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1af7528d62028e0b7e022734b00f8aeb1b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void gr_buffer::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="80"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a89a1d9c85ba243e952a62015c7009d8d" 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::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="81" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="81" bodyend="81"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a3e5c410222891cad5b7d5b85ff82b85f" 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::link</definition>
<argsstring>()</argsstring>
<name>link</name>
<briefdescription>
<para>Return the block that writes to this buffer. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="86" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="86" bodyend="86"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a2eb5af8306fe4a2c6d6838ff41b3240b" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="non-virtual">
<type>size_t</type>
<definition>size_t gr_buffer::nreaders</definition>
<argsstring>() const </argsstring>
<name>nreaders</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="88" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="88" bodyend="88"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a2009bf87ea09dd35abd0f42030911381" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type><ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref> *</type>
<definition>gr_buffer_reader* gr_buffer::reader</definition>
<argsstring>(size_t index)</argsstring>
<name>reader</name>
<param>
<type>size_t</type>
<declname>index</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="89" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="89" bodyend="89"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1afb6b8a5f64a9d556a80ce528168fcd7b" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type>boost::mutex *</type>
<definition>boost::mutex* gr_buffer::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="91" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="91" bodyend="91"/>
</memberdef>
</sectiondef>
<sectiondef kind="private-func">
<memberdef kind="function" id="classgr__buffer_1aa342c611f82264a19900347aec141d31" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type>unsigned</type>
<definition>unsigned gr_buffer::index_add</definition>
<argsstring>(unsigned a, unsigned b)</argsstring>
<name>index_add</name>
<param>
<type>unsigned</type>
<declname>a</declname>
</param>
<param>
<type>unsigned</type>
<declname>b</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="119" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="118" bodyend="127"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1aafa0c53ad2b6907137f4938ac4c04133" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
<type>unsigned</type>
<definition>unsigned gr_buffer::index_sub</definition>
<argsstring>(unsigned a, unsigned b)</argsstring>
<name>index_sub</name>
<param>
<type>unsigned</type>
<declname>a</declname>
</param>
<param>
<type>unsigned</type>
<declname>b</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="131" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="130" bodyend="139"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1ac5d11dd803413063783d7553a30e2925" prot="private" static="no" const="no" explicit="no" inline="no" virt="virtual">
<type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
<definition>virtual bool gr_buffer::allocate_buffer</definition>
<argsstring>(int nitems, size_t sizeof_item)</argsstring>
<name>allocate_buffer</name>
<param>
<type>int</type>
<declname>nitems</declname>
</param>
<param>
<type>size_t</type>
<declname>sizeof_item</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="141"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a037ac1055d472175f763c21edb792c25" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type></type>
<definition>gr_buffer::gr_buffer</definition>
<argsstring>(int nitems, size_t sizeof_item, gr_block_sptr link)</argsstring>
<name>gr_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>
</param>
<briefdescription>
<para>constructor is private. Use gr_make_buffer to create instances. </para> </briefdescription>
<detaileddescription>
<para>Allocate a buffer that holds at least <computeroutput>nitems</computeroutput> of size <computeroutput>sizeof_item</computeroutput>.</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>
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> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="156"/>
</memberdef>
<memberdef kind="function" id="classgr__buffer_1a5dbf84734d797bfc776dc66571ec17ce" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void gr_buffer::drop_reader</definition>
<argsstring>(gr_buffer_reader *reader)</argsstring>
<name>drop_reader</name>
<param>
<type><ref refid="classgr__buffer__reader" kindref="compound">gr_buffer_reader</ref> *</type>
<declname>reader</declname>
</param>
<briefdescription>
<para>disassociate <computeroutput>reader</computeroutput> from this buffer </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" line="161"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Single writer, multiple reader fifo. </para> </briefdescription>
<detaileddescription>
</detaileddescription>
<collaborationgraph>
<node id="6794">
<label>std::vector< gr_buffer_reader * ></label>
<link refid="classstd_1_1vector"/>
<childnode refid="6795" relation="usage">
<edgelabel>p</edgelabel>
<edgelabel>elements</edgelabel>
</childnode>
</node>
<node id="6795">
<label>gr_buffer_reader</label>
<link refid="classgr__buffer__reader"/>
<childnode refid="6796" relation="usage">
<edgelabel>d_buffer</edgelabel>
</childnode>
</node>
<node id="6793">
<label>gr_vmcircbuf</label>
<link refid="classgr__vmcircbuf"/>
</node>
<node id="6792">
<label>gr_buffer</label>
<link refid="classgr__buffer"/>
<childnode refid="6793" relation="usage">
<edgelabel>d_vmcircbuf</edgelabel>
</childnode>
<childnode refid="6794" relation="usage">
<edgelabel>d_readers</edgelabel>
</childnode>
</node>
<node id="6796">
<label>boost::shared_ptr< gr_buffer ></label>
<link refid="classboost_1_1shared__ptr"/>
<childnode refid="6792" 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="50" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_buffer.h" bodystart="50" bodyend="163"/>
<listofallmembers>
<member refid="classgr__buffer_1ac5d11dd803413063783d7553a30e2925" prot="private" virt="virtual"><scope>gr_buffer</scope><name>allocate_buffer</name></member>
<member refid="classgr__buffer_1a39a2c75577d0b37f7eef0b930d588da4" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>bufsize</name></member>
<member refid="classgr__buffer_1a60aa2c93de67e9c5782a34130aac8da3" prot="protected" virt="non-virtual"><scope>gr_buffer</scope><name>d_base</name></member>
<member refid="classgr__buffer_1a2ce1b319068ce94e4799b7affe4b48ae" prot="protected" virt="non-virtual"><scope>gr_buffer</scope><name>d_bufsize</name></member>
<member refid="classgr__buffer_1ac0aa4692972c778d6eabadab3c006982" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>d_done</name></member>
<member refid="classgr__buffer_1aadfe3072e4aa511b0a20b9d5769817fb" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>d_link</name></member>
<member refid="classgr__buffer_1acbeb7c22848ee841ae26443a5a949bc4" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>d_mutex</name></member>
<member refid="classgr__buffer_1a07555097fda9bd99e23fd8649971bf7d" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>d_readers</name></member>
<member refid="classgr__buffer_1ab1456289193ea99bb03e9a683b6320aa" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>d_sizeof_item</name></member>
<member refid="classgr__buffer_1a1f4a14166f2750055fce78f19668f507" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>d_vmcircbuf</name></member>
<member refid="classgr__buffer_1a25bae292c516aaac0b39b8cf6eb7db7e" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>d_write_index</name></member>
<member refid="classgr__buffer_1a89a1d9c85ba243e952a62015c7009d8d" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>done</name></member>
<member refid="classgr__buffer_1a5dbf84734d797bfc776dc66571ec17ce" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>drop_reader</name></member>
<member refid="classgr__buffer_1a037ac1055d472175f763c21edb792c25" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>gr_buffer</name></member>
<member refid="classgr__buffer_1afb5b9797c2e10e7f5d456643d3b420cb" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>gr_buffer_add_reader</name></member>
<member refid="classgr__buffer_1a7ecfad759b1fdf2dcb7416a16f563482" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>gr_buffer_reader</name></member>
<member refid="classgr__buffer_1a9c3543ee3c4e4eea1d8ea5c3705ecdbf" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>gr_make_buffer</name></member>
<member refid="classgr__buffer_1aa342c611f82264a19900347aec141d31" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>index_add</name></member>
<member refid="classgr__buffer_1aafa0c53ad2b6907137f4938ac4c04133" prot="private" virt="non-virtual"><scope>gr_buffer</scope><name>index_sub</name></member>
<member refid="classgr__buffer_1a3e5c410222891cad5b7d5b85ff82b85f" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>link</name></member>
<member refid="classgr__buffer_1afb6b8a5f64a9d556a80ce528168fcd7b" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>mutex</name></member>
<member refid="classgr__buffer_1a2eb5af8306fe4a2c6d6838ff41b3240b" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>nreaders</name></member>
<member refid="classgr__buffer_1a2009bf87ea09dd35abd0f42030911381" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>reader</name></member>
<member refid="classgr__buffer_1aff98726da27f70ef316640f925636260" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>scoped_lock</name></member>
<member refid="classgr__buffer_1af7528d62028e0b7e022734b00f8aeb1b" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>set_done</name></member>
<member refid="classgr__buffer_1a1d064236bb139c339a425b51212813b1" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>space_available</name></member>
<member refid="classgr__buffer_1aba102b9c8394068b2c4b570c0e788e82" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>update_write_pointer</name></member>
<member refid="classgr__buffer_1a1a4dc904e4da49e58a3405550665a712" prot="public" virt="non-virtual"><scope>gr_buffer</scope><name>write_pointer</name></member>
<member refid="classgr__buffer_1ab3c5c8028b30a30c6c3eb3015225ba4b" prot="public" virt="virtual"><scope>gr_buffer</scope><name>~gr_buffer</name></member>
</listofallmembers>
</compounddef>
</doxygen>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
7525
