<!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: circular_buffer< T > Class Template 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('classcircular__buffer.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classcircular__buffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">circular_buffer< T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="circular__buffer_8h_source.html">circular_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:abe47d88305c64a91fa8fb6fe10b63bb0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#abe47d88305c64a91fa8fb6fe10b63bb0">circular_buffer</a> (size_t bufLen_I, bool doWriteBlock=true, bool doFullRead=false)</td></tr>
<tr class="separator:abe47d88305c64a91fa8fb6fe10b63bb0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fa47d36777b9522904c0b6165d3183f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a6fa47d36777b9522904c0b6165d3183f">~circular_buffer</a> ()</td></tr>
<tr class="separator:a6fa47d36777b9522904c0b6165d3183f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b17b62a2c64f5b86759268b4439c00f"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a7b17b62a2c64f5b86759268b4439c00f">n_avail_write_items</a> ()</td></tr>
<tr class="separator:a7b17b62a2c64f5b86759268b4439c00f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8118badb1d022ba8f0497f24cec96b75"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a8118badb1d022ba8f0497f24cec96b75">n_avail_read_items</a> ()</td></tr>
<tr class="separator:a8118badb1d022ba8f0497f24cec96b75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d3199c0412409093c23518771d6acf4"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a9d3199c0412409093c23518771d6acf4">buffer_length_items</a> ()</td></tr>
<tr class="separator:a9d3199c0412409093c23518771d6acf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadcd544c25a138781fa6e0e43b49665d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#aadcd544c25a138781fa6e0e43b49665d">do_write_block</a> ()</td></tr>
<tr class="separator:aadcd544c25a138781fa6e0e43b49665d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1af3c61175877bd0fe3baf2130ce65c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#aa1af3c61175877bd0fe3baf2130ce65c">do_full_read</a> ()</td></tr>
<tr class="separator:aa1af3c61175877bd0fe3baf2130ce65c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc29c0f342fa153d64561b622e3cf3d4"><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="classcircular__buffer.html#acc29c0f342fa153d64561b622e3cf3d4">reset</a> ()</td></tr>
<tr class="separator:acc29c0f342fa153d64561b622e3cf3d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abcd24de17aa8258835c6dff2c027a6d6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#abcd24de17aa8258835c6dff2c027a6d6">enqueue</a> (T *buf, size_t bufLen_I)</td></tr>
<tr class="separator:abcd24de17aa8258835c6dff2c027a6d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f86491a41b04da07ed2f5b3dbc748d1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcircular__buffer.html#a7f86491a41b04da07ed2f5b3dbc748d1">dequeue</a> (T *buf, size_t *bufLen_I)</td></tr>
<tr class="separator:a7f86491a41b04da07ed2f5b3dbc748d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1da17d5f94fe3ca1ffca42a5d307f4f5"><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="classcircular__buffer.html#a1da17d5f94fe3ca1ffca42a5d307f4f5">abort</a> ()</td></tr>
<tr class="separator:a1da17d5f94fe3ca1ffca42a5d307f4f5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abe47d88305c64a91fa8fb6fe10b63bb0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::<a class="el" href="classcircular__buffer.html">circular_buffer</a> </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufLen_I</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>doWriteBlock</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>doFullRead</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</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="a6fa47d36777b9522904c0b6165d3183f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::~<a class="el" href="classcircular__buffer.html">circular_buffer</a> </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1da17d5f94fe3ca1ffca42a5d307f4f5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<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> <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::abort </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="a9d3199c0412409093c23518771d6acf4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::buffer_length_items </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="a7f86491a41b04da07ed2f5b3dbc748d1"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::dequeue </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"><em>bufLen_I</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa1af3c61175877bd0fe3baf2130ce65c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::do_full_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="aadcd544c25a138781fa6e0e43b49665d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::do_write_block </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="abcd24de17aa8258835c6dff2c027a6d6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::enqueue </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufLen_I</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8118badb1d022ba8f0497f24cec96b75"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::n_avail_read_items </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="a7b17b62a2c64f5b86759268b4439c00f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::n_avail_write_items </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="acc29c0f342fa153d64561b622e3cf3d4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<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> <a class="el" href="classcircular__buffer.html">circular_buffer</a>< T >::reset </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>Referenced by <a class="el" href="classcircular__buffer.html#abe47d88305c64a91fa8fb6fe10b63bb0">circular_buffer< float >::circular_buffer()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="circular__buffer_8h_source.html">circular_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="classcircular__buffer.html">circular_buffer</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:36 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>
