<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>circular_buffer.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">circular_buffer.h</div> </div>
</div>
<div class="contents">
<a href="circular__buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef circular_buffer_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define circular_buffer_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="comment">// Note: This file is included from "stl_extensions.h"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <vector></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">namespace </span>mrpt
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">namespace </span>utils
<a name="l00039"></a>00039 {<span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment"> /** A circular buffer of fixed size (defined at construction-time), implemented with a std::vector as the underlying storage.</span>
<a name="l00041"></a>00041 <span class="comment"> * \ingroup stlext_grp</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <span class="keyword">template</span> <<span class="keyword">typename</span> T>
<a name="l00044"></a>00044 <span class="keyword">class </span>circular_buffer
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keyword">private</span>:
<a name="l00047"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a51544c7b9c6542d247af25fb6ed5658f">00047</a> std<a class="code" href="classstd_1_1vector.html">::vector<T></a> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a51544c7b9c6542d247af25fb6ed5658f">m_data</a>;
<a name="l00048"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">00048</a> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>;
<a name="l00049"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">00049</a> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>,<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00052"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a02acd71dfa53720462a0776c1053690a">00052</a> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a02acd71dfa53720462a0776c1053690a">circular_buffer</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a983ee6228c9a350cdea14c3de419ad6b" title="Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size ...">size</a>) :
<a name="l00053"></a>00053 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a51544c7b9c6542d247af25fb6ed5658f">m_data</a>(size),
<a name="l00054"></a>00054 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>(size),
<a name="l00055"></a>00055 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>(0),
<a name="l00056"></a>00056 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>(0)
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a><=2) <span class="keywordflow">throw</span> <a class="code" href="classstd_1_1invalid__argument.html" title="STL class.">std::invalid_argument</a>(<span class="stringliteral">"size must be >2"</span>);
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060 <span class="comment">//virtual ~circular_buffer() { }</span>
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment"> /** Insert a copy of the given element in the buffer.</span>
<a name="l00063"></a>00063 <span class="comment"> * \exception std::out_of_range If the buffer run out of space.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af15fbef9d1ea7a52f52b8d9980240c23">00065</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af15fbef9d1ea7a52f52b8d9980240c23" title="Insert a copy of the given element in the buffer.">push</a>(T d) {
<a name="l00066"></a>00066 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a51544c7b9c6542d247af25fb6ed5658f">m_data</a>[<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>++]=d;
<a name="l00067"></a>00067 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>) <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>=0;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>)
<a name="l00070"></a>00070 <span class="keywordflow">throw</span> <a class="code" href="classstd_1_1out__of__range.html" title="STL class.">std::out_of_range</a>(<span class="stringliteral">"push: circular_buffer is full"</span>);
<a name="l00071"></a>00071 }
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment"> /** Insert a reference of the given element in the buffer.</span>
<a name="l00074"></a>00074 <span class="comment"> * \exception std::out_of_range If the buffer run out of space.</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a1cc33b9e4a7c9d8ab6cd968be08a9578">00076</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a1cc33b9e4a7c9d8ab6cd968be08a9578" title="Insert a reference of the given element in the buffer.">push_ref</a>(<span class="keyword">const</span> T &d) {
<a name="l00077"></a>00077 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a51544c7b9c6542d247af25fb6ed5658f">m_data</a>[<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>++]=d;
<a name="l00078"></a>00078 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>) <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>=0;
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>)
<a name="l00081"></a>00081 <span class="keywordflow">throw</span> <a class="code" href="classstd_1_1out__of__range.html" title="STL class.">std::out_of_range</a>(<span class="stringliteral">"push: circular_buffer is full"</span>);
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /** Insert an array of elements in the buffer.</span>
<a name="l00085"></a>00085 <span class="comment"> * \exception std::out_of_range If the buffer run out of space.</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a748d31748cfcd426ef90ef3e6244a900">00087</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a748d31748cfcd426ef90ef3e6244a900" title="Insert an array of elements in the buffer.">push_many</a>(T *array_elements, <span class="keywordtype">size_t</span> count) {
<a name="l00088"></a>00088 <span class="keywordflow">while</span> (count--)
<a name="l00089"></a>00089 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af15fbef9d1ea7a52f52b8d9980240c23" title="Insert a copy of the given element in the buffer.">push</a>(*array_elements++);
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /** Retrieve an element from the buffer.</span>
<a name="l00093"></a>00093 <span class="comment"> * \exception std::out_of_range If the buffer is empty.</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a65e49f0b3fe37040e4fb0d3aab4217ee">00095</a> T <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a65e49f0b3fe37040e4fb0d3aab4217ee" title="Retrieve an element from the buffer.">pop</a>() {
<a name="l00096"></a>00096 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>)
<a name="l00097"></a>00097 <span class="keywordflow">throw</span> <a class="code" href="classstd_1_1out__of__range.html" title="STL class.">std::out_of_range</a>(<span class="stringliteral">"pop: circular_buffer is empty"</span>);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">const</span> <span class="keywordtype">size_t</span> i = <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>++;
<a name="l00100"></a>00100 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>) <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>=0;
<a name="l00101"></a>00101 <span class="keywordflow">return</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a51544c7b9c6542d247af25fb6ed5658f">m_data</a>[i];
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment"> /** Retrieve an element from the buffer.</span>
<a name="l00105"></a>00105 <span class="comment"> * \exception std::out_of_range If the buffer is empty.</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
<a name="l00107"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#aa6e75033090faa245363ad3174c8ccc7">00107</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#aa6e75033090faa245363ad3174c8ccc7" title="Retrieve an element from the buffer.">pop</a>(T &out_val) {
<a name="l00108"></a>00108 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>)
<a name="l00109"></a>00109 <span class="keywordflow">throw</span> <a class="code" href="classstd_1_1out__of__range.html" title="STL class.">std::out_of_range</a>(<span class="stringliteral">"pop: circular_buffer is empty"</span>);
<a name="l00110"></a>00110
<a name="l00111"></a>00111 out_val=<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a51544c7b9c6542d247af25fb6ed5658f">m_data</a>[<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>++];
<a name="l00112"></a>00112 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>==<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>) <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>=0;
<a name="l00113"></a>00113 }
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment"> /** Pop a number of elements into a user-provided array.</span>
<a name="l00116"></a>00116 <span class="comment"> * \exception std::out_of_range If the buffer has less elements than requested.</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a45f995c9af584ecaf886167474c17cc9">00118</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a45f995c9af584ecaf886167474c17cc9" title="Pop a number of elements into a user-provided array.">pop_many</a>(T *out_array, <span class="keywordtype">size_t</span> count) {
<a name="l00119"></a>00119 <span class="keywordflow">while</span> (count--)
<a name="l00120"></a>00120 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a65e49f0b3fe37040e4fb0d3aab4217ee" title="Retrieve an element from the buffer.">pop</a>(*out_array++);
<a name="l00121"></a>00121 }
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> /** Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size of the internal buffer)</span>
<a name="l00124"></a>00124 <span class="comment"> * \sa capacity</span>
<a name="l00125"></a>00125 <span class="comment"> */</span>
<a name="l00126"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a983ee6228c9a350cdea14c3de419ad6b">00126</a> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a983ee6228c9a350cdea14c3de419ad6b" title="Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size ...">size</a>()<span class="keyword"> const </span>{
<a name="l00127"></a>00127 <span class="keywordflow">if</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>>=<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>)
<a name="l00128"></a>00128 <span class="keywordflow">return</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a>-<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>;
<a name="l00129"></a>00129 <span class="keywordflow">else</span> <span class="keywordflow">return</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a> + (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>-<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a>);
<a name="l00130"></a>00130 }
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment"> /** Return the maximum capacity of the buffer.</span>
<a name="l00133"></a>00133 <span class="comment"> * \sa size</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a5688343e62ab0703d2334bb5b018cf89">00135</a> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a5688343e62ab0703d2334bb5b018cf89" title="Return the maximum capacity of the buffer.">capacity</a>()<span class="keyword"> const </span>{
<a name="l00136"></a>00136 <span class="keywordflow">return</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#ae7654c14bf0d2b5e02787fca808a254a">m_size</a>;
<a name="l00137"></a>00137 }
<a name="l00138"></a>00138 <span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment"> /** The maximum number of elements that can be written ("push") without rising an overflow error.</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#aa68d4f859ba091935b75ff8e6ad5bfb4">00141</a> <span class="keywordtype">size_t</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#aa68d4f859ba091935b75ff8e6ad5bfb4" title="The maximum number of elements that can be written ("push") without rising an overflow error...">available</a>()<span class="keyword"> const </span>{
<a name="l00142"></a>00142 <span class="keywordflow">return</span> (<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a5688343e62ab0703d2334bb5b018cf89" title="Return the maximum capacity of the buffer.">capacity</a>()-<a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a983ee6228c9a350cdea14c3de419ad6b" title="Return the number of elements available for read ("pop") in the buffer (this is NOT the maximum size ...">size</a>())-1;
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144 <span class="comment"></span>
<a name="l00145"></a>00145 <span class="comment"> /** Delete all the stored data, if any. */</span>
<a name="l00146"></a><a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a5c1e7d8bdcb1fb2c56b619f5616411ad">00146</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a5c1e7d8bdcb1fb2c56b619f5616411ad" title="Delete all the stored data, if any.">clear</a>() {
<a name="l00147"></a>00147 <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#af1db45ebe9f1ce2b561cc56ebadd6ca3">m_next_write</a> = <a class="code" href="classmrpt_1_1utils_1_1circular__buffer.html#a0eb2b992813d37fba611848dc3bab11a">m_next_read</a> = 0;
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149
<a name="l00150"></a>00150 }; <span class="comment">// end class circular_buffer</span>
<a name="l00151"></a>00151
<a name="l00152"></a>00152 } <span class="comment">// End of namespace</span>
<a name="l00153"></a>00153 } <span class="comment">// End of namespace</span>
<a name="l00154"></a>00154 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
