<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_buffer_reader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classgr__buffer__reader.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classgr__buffer__reader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr_buffer_reader Class Reference<div class="ingroups"><a class="el" href="group__internal.html">Implementation Details</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>How we keep track of the readers of a <a class="el" href="classgr__buffer.html" title="Single writer, multiple reader fifo.">gr_buffer</a>.
<a href="classgr__buffer__reader.html#details">More...</a></p>
<p><code>#include <<a class="el" href="gr__buffer_8h_source.html">gr_buffer.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a296f93185ddabe97c74ee2bfc1858194"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a296f93185ddabe97c74ee2bfc1858194">~gr_buffer_reader</a> ()</td></tr>
<tr class="separator:a296f93185ddabe97c74ee2bfc1858194"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ef86082ac536ac95ec469f27d99d6a0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a1ef86082ac536ac95ec469f27d99d6a0">items_available</a> () const </td></tr>
<tr class="memdesc:a1ef86082ac536ac95ec469f27d99d6a0"><td class="mdescLeft"> </td><td class="mdescRight">Return number of items available for reading. <a href="#a1ef86082ac536ac95ec469f27d99d6a0"></a><br/></td></tr>
<tr class="separator:a1ef86082ac536ac95ec469f27d99d6a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1f9fc3b86fea8da9cfdb6f693b0d8b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#aa1f9fc3b86fea8da9cfdb6f693b0d8b1">buffer</a> () const </td></tr>
<tr class="memdesc:aa1f9fc3b86fea8da9cfdb6f693b0d8b1"><td class="mdescLeft"> </td><td class="mdescRight">Return buffer this reader reads from. <a href="#aa1f9fc3b86fea8da9cfdb6f693b0d8b1"></a><br/></td></tr>
<tr class="separator:aa1f9fc3b86fea8da9cfdb6f693b0d8b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87ef46cf000ef6168115b8b06cfd0ce8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a87ef46cf000ef6168115b8b06cfd0ce8">max_possible_items_available</a> () const </td></tr>
<tr class="memdesc:a87ef46cf000ef6168115b8b06cfd0ce8"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="#a87ef46cf000ef6168115b8b06cfd0ce8"></a><br/></td></tr>
<tr class="separator:a87ef46cf000ef6168115b8b06cfd0ce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0a07401b38ed900cb53e72193233ddf"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#aa0a07401b38ed900cb53e72193233ddf">read_pointer</a> ()</td></tr>
<tr class="memdesc:aa0a07401b38ed900cb53e72193233ddf"><td class="mdescLeft"> </td><td class="mdescRight">return pointer to read buffer. <a href="#aa0a07401b38ed900cb53e72193233ddf"></a><br/></td></tr>
<tr class="separator:aa0a07401b38ed900cb53e72193233ddf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a8e969300be7ffa49811109f27005c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a6a8e969300be7ffa49811109f27005c4">update_read_pointer</a> (int nitems)</td></tr>
<tr class="separator:a6a8e969300be7ffa49811109f27005c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b550f828745a575387ead9701174665"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a8b550f828745a575387ead9701174665">set_done</a> (bool <a class="el" href="classgr__buffer__reader.html#a1b0037b814e8576b279fe307c47dd5a5">done</a>)</td></tr>
<tr class="separator:a8b550f828745a575387ead9701174665"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b0037b814e8576b279fe307c47dd5a5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a1b0037b814e8576b279fe307c47dd5a5">done</a> () const </td></tr>
<tr class="separator:a1b0037b814e8576b279fe307c47dd5a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7cab1e800a289bdbb4879f4f3a38873"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#ad7cab1e800a289bdbb4879f4f3a38873">mutex</a> ()</td></tr>
<tr class="separator:ad7cab1e800a289bdbb4879f4f3a38873"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adfc6222670ba28a359dd1e855a69a6ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#adfc6222670ba28a359dd1e855a69a6ee">nitems_read</a> ()</td></tr>
<tr class="separator:adfc6222670ba28a359dd1e855a69a6ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaff18b837411388f757f7cae21049f52"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#aaff18b837411388f757f7cae21049f52">get_sizeof_item</a> ()</td></tr>
<tr class="separator:aaff18b837411388f757f7cae21049f52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd78edc8986ecdb3b78a3add8e2ebfde"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#acd78edc8986ecdb3b78a3add8e2ebfde">link</a> ()</td></tr>
<tr class="memdesc:acd78edc8986ecdb3b78a3add8e2ebfde"><td class="mdescLeft"> </td><td class="mdescRight">Return the block that reads via this reader. <a href="#acd78edc8986ecdb3b78a3add8e2ebfde"></a><br/></td></tr>
<tr class="separator:acd78edc8986ecdb3b78a3add8e2ebfde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaab943f9a5a9f25a86f66d6bf8c27fc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#aaab943f9a5a9f25a86f66d6bf8c27fc2">get_tags_in_range</a> (std::vector< <a class="el" href="structgr__tag__t.html">gr_tag_t</a> > &v, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_start, <a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> abs_end)</td></tr>
<tr class="memdesc:aaab943f9a5a9f25a86f66d6bf8c27fc2"><td class="mdescLeft"> </td><td class="mdescRight">Given a [start,end), returns a vector all tags in the range. <a href="#aaab943f9a5a9f25a86f66d6bf8c27fc2"></a><br/></td></tr>
<tr class="separator:aaab943f9a5a9f25a86f66d6bf8c27fc2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a25dff068f5cfde18c4307b4973f4db9d"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#a25dff068f5cfde18c4307b4973f4db9d">gr_buffer</a></td></tr>
<tr class="separator:a25dff068f5cfde18c4307b4973f4db9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc1ca197033760254a594982fde1a4a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__buffer__reader.html#adc1ca197033760254a594982fde1a4a0">gr_buffer_add_reader</a> (<a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> buf, int nzero_preload, <a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> <a class="el" href="classgr__buffer__reader.html#acd78edc8986ecdb3b78a3add8e2ebfde">link</a>)</td></tr>
<tr class="memdesc:adc1ca197033760254a594982fde1a4a0"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a> and attach it to buffer <code>buf</code>. <a href="#adc1ca197033760254a594982fde1a4a0"></a><br/></td></tr>
<tr class="separator:adc1ca197033760254a594982fde1a4a0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>How we keep track of the readers of a <a class="el" href="classgr__buffer.html" title="Single writer, multiple reader fifo.">gr_buffer</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a296f93185ddabe97c74ee2bfc1858194"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_buffer_reader::~gr_buffer_reader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa1f9fc3b86fea8da9cfdb6f693b0d8b1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> gr_buffer_reader::buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return buffer this reader reads from. </p>
</div>
</div>
<a class="anchor" id="a1b0037b814e8576b279fe307c47dd5a5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool gr_buffer_reader::done </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aaff18b837411388f757f7cae21049f52"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t gr_buffer_reader::get_sizeof_item </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aaab943f9a5a9f25a86f66d6bf8c27fc2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_buffer_reader::get_tags_in_range </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="structgr__tag__t.html">gr_tag_t</a> > & </td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> </td>
<td class="paramname"><em>abs_start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> </td>
<td class="paramname"><em>abs_end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Given a [start,end), returns a vector all tags in the range. </p>
<p>Get a vector of tags in given range. Range of counts is from start to end-1.</p>
<p>Tags are tuples of: (item count, source id, key, value)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>a vector reference to return tags into </td></tr>
<tr><td class="paramname">abs_start</td><td>a uint64 count of the start of the range of interest </td></tr>
<tr><td class="paramname">abs_end</td><td>a uint64 count of the end of the range of interest </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1ef86082ac536ac95ec469f27d99d6a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_buffer_reader::items_available </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return number of items available for reading. </p>
</div>
</div>
<a class="anchor" id="acd78edc8986ecdb3b78a3add8e2ebfde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> gr_buffer_reader::link </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the block that reads via this reader. </p>
</div>
</div>
<a class="anchor" id="a87ef46cf000ef6168115b8b06cfd0ce8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int gr_buffer_reader::max_possible_items_available </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
</div>
</div>
<a class="anchor" id="ad7cab1e800a289bdbb4879f4f3a38873"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegruel.html#a16a913898c1d7f7a8ee459eb7ace413d">gruel::mutex</a>* gr_buffer_reader::mutex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adfc6222670ba28a359dd1e855a69a6ee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="stdint_8h.html#aec6fcb673ff035718c238c8c9d544c47">uint64_t</a> gr_buffer_reader::nitems_read </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa0a07401b38ed900cb53e72193233ddf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a>* gr_buffer_reader::read_pointer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>return pointer to read buffer. </p>
<p>The return value points to <a class="el" href="classgr__buffer__reader.html#a1ef86082ac536ac95ec469f27d99d6a0" title="Return number of items available for reading.">items_available()</a> number of items </p>
</div>
</div>
<a class="anchor" id="a8b550f828745a575387ead9701174665"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_buffer_reader::set_done </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>done</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6a8e969300be7ffa49811109f27005c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_buffer_reader::update_read_pointer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>nitems</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a25dff068f5cfde18c4307b4973f4db9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classgr__buffer.html">gr_buffer</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adc1ca197033760254a594982fde1a4a0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_reader_sptr</a> gr_buffer_add_reader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_buffer_sptr</a> </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nzero_preload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classboost_1_1shared__ptr.html">gr_block_sptr</a> </td>
<td class="paramname"><em>link</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new <a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a> and attach it to buffer <code>buf</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>is the buffer the <code><a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a></code> reads from. </td></tr>
<tr><td class="paramname">nzero_preload</td><td>– number of zero items to "preload" into buffer. </td></tr>
<tr><td class="paramname">link</td><td>is the block that reads from the buffer using this <a class="el" href="classgr__buffer__reader.html" title="How we keep track of the readers of a gr_buffer.">gr_buffer_reader</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__buffer_8h_source.html">gr_buffer.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classgr__buffer__reader.html">gr_buffer_reader</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:37 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
