<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: drivers/CircularBuffer/CircularBuffer.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_c09cb064081452845366d2659782fde4.html">CircularBuffer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">CircularBuffer.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_circular_buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> CircularBuffer - An Arduino circular buffering library for arbitrary types.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span> </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Created by Ivo Pullens, Emmission, 2014-2016 -- www.emmission.nl</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#ifndef CircularBuffer_h</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define CircularBuffer_h</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_circular_buffer.html"> 34</a></span> <span class="keyword">template</span> <<span class="keyword">class</span> T> <span class="keyword">class </span><a class="code" href="class_circular_buffer.html">CircularBuffer</a></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#acfcba7c1239a2bef9da03005975640f2"> 42</a></span>  <a class="code" href="class_circular_buffer.html#acfcba7c1239a2bef9da03005975640f2">CircularBuffer</a>(T* buffer, <span class="keyword">const</span> uint8_t size )</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  : <a class="code" href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46">m_size</a>(size), <a class="code" href="class_circular_buffer.html#a4ae7d8486d1535f5f64b8a7f955a5309">m_buff</a>(buffer)</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="class_circular_buffer.html#a09e7ce81b3018eb511a54abf2b5292fa">clear</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a09e7ce81b3018eb511a54abf2b5292fa"> 51</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_circular_buffer.html#a09e7ce81b3018eb511a54abf2b5292fa">clear</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">m_front</a> = 0;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a> = 0;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5"> 63</a></span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5">empty</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">bool</span> <a class="code" href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5">empty</a>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5">empty</a> = !<a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> <a class="code" href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5">empty</a>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  }</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4"> 76</a></span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4">full</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">bool</span> <a class="code" href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4">full</a>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4">full</a> = <a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a> == <a class="code" href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46">m_size</a>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> <a class="code" href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4">full</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a423f9f79766010b2c47502bf2f584018"> 89</a></span>  <span class="keyword">inline</span> uint8_t <a class="code" href="class_circular_buffer.html#a423f9f79766010b2c47502bf2f584018">available</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  uint8_t ret_value;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  ret_value = <a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> ret_value;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a8f6cfb9986df3cb77d89615709370767"> 104</a></span>  T* <a class="code" href="class_circular_buffer.html#a8f6cfb9986df3cb77d89615709370767">getFront</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">if</span> (!<a class="code" href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4">full</a>())</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  {</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">return</span> <a class="code" href="class_circular_buffer.html#acc10fe8e7d97d6ac8fa010c1f9a3e958">get</a>(<a class="code" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">m_front</a>);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  }</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>T*<span class="keyword">></span>(NULL);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  }</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#af64f94ddb7657c23ad232bec4b1de282"> 121</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_circular_buffer.html#af64f94ddb7657c23ad232bec4b1de282">pushFront</a>(T* record)</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  {</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordflow">if</span> (!<a class="code" href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4">full</a>())</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  {</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  T* f = <a class="code" href="class_circular_buffer.html#acc10fe8e7d97d6ac8fa010c1f9a3e958">get</a>(<a class="code" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">m_front</a>);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordflow">if</span> (f != record) {</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  *f = *record;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <a class="code" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">m_front</a> = (<a class="code" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">m_front</a>+1) % <a class="code" href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46">m_size</a>;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a>++;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  </div>
<div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a501b884153e525a38724c5299243afd9"> 144</a></span>  T* <a class="code" href="class_circular_buffer.html#a501b884153e525a38724c5299243afd9">getBack</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordflow">if</span> (!<a class="code" href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5">empty</a>())</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  {</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">return</span> <a class="code" href="class_circular_buffer.html#acc10fe8e7d97d6ac8fa010c1f9a3e958">get</a>(<a class="code" href="class_circular_buffer.html#a6d300351639b13338b1fc6fc59e42c96">back</a>());</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  }</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  }</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span>T*<span class="keyword">></span>(NULL);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  }</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
<div class="line"><a name="l00159"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a4fed074db05fe6a5a2ec232f975a66c9"> 159</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_circular_buffer.html#a4fed074db05fe6a5a2ec232f975a66c9">popBack</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  {</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  MY_CRITICAL_SECTION {</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordflow">if</span> (!<a class="code" href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5">empty</a>())</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  {</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a>--;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  }</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  }</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  }</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#acc10fe8e7d97d6ac8fa010c1f9a3e958"> 177</a></span>  <span class="keyword">inline</span> T * <a class="code" href="class_circular_buffer.html#acc10fe8e7d97d6ac8fa010c1f9a3e958">get</a>(<span class="keyword">const</span> uint8_t idx)<span class="keyword"> const</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordflow">return</span> &(<a class="code" href="class_circular_buffer.html#a4ae7d8486d1535f5f64b8a7f955a5309">m_buff</a>[idx]);</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  </div>
<div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a6d300351639b13338b1fc6fc59e42c96"> 186</a></span>  <span class="keyword">inline</span> uint8_t <a class="code" href="class_circular_buffer.html#a6d300351639b13338b1fc6fc59e42c96">back</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordflow">return</span> (<a class="code" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">m_front</a> - <a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a> + <a class="code" href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46">m_size</a>) % <a class="code" href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46">m_size</a>;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  }</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div>
<div class="line"><a name="l00191"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46"> 191</a></span>  <span class="keyword">const</span> uint8_t <a class="code" href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46">m_size</a>; </div>
<div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a4ae7d8486d1535f5f64b8a7f955a5309"> 192</a></span>  T* <span class="keyword">const</span> <a class="code" href="class_circular_buffer.html#a4ae7d8486d1535f5f64b8a7f955a5309">m_buff</a>; </div>
<div class="line"><a name="l00193"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838"> 193</a></span>  <span class="keyword">volatile</span> uint8_t <a class="code" href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">m_front</a>; </div>
<div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea"> 194</a></span>  <span class="keyword">volatile</span> uint8_t <a class="code" href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">m_fill</a>; </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> };</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="preprocessor">#endif // CircularBuffer_h</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_circular_buffer_html"><div class="ttname"><a href="class_circular_buffer.html">CircularBuffer</a></div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:34</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a09e7ce81b3018eb511a54abf2b5292fa"><div class="ttname"><a href="class_circular_buffer.html#a09e7ce81b3018eb511a54abf2b5292fa">CircularBuffer::clear</a></div><div class="ttdeci">void clear(void)</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:51</div></div>
<div class="ttc" id="aclass_circular_buffer_html_acfcba7c1239a2bef9da03005975640f2"><div class="ttname"><a href="class_circular_buffer.html#acfcba7c1239a2bef9da03005975640f2">CircularBuffer::CircularBuffer</a></div><div class="ttdeci">CircularBuffer(T *buffer, const uint8_t size)</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:42</div></div>
<div class="ttc" id="aclass_circular_buffer_html_add5ab2044b29293c9a42e7c596546eb5"><div class="ttname"><a href="class_circular_buffer.html#add5ab2044b29293c9a42e7c596546eb5">CircularBuffer::empty</a></div><div class="ttdeci">bool empty(void) const</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:63</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a6d300351639b13338b1fc6fc59e42c96"><div class="ttname"><a href="class_circular_buffer.html#a6d300351639b13338b1fc6fc59e42c96">CircularBuffer::back</a></div><div class="ttdeci">uint8_t back(void) const</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:186</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a3f63d37b336ecd79e1a09dd0c81d02c4"><div class="ttname"><a href="class_circular_buffer.html#a3f63d37b336ecd79e1a09dd0c81d02c4">CircularBuffer::full</a></div><div class="ttdeci">bool full(void) const</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:76</div></div>
<div class="ttc" id="aclass_circular_buffer_html_acc10fe8e7d97d6ac8fa010c1f9a3e958"><div class="ttname"><a href="class_circular_buffer.html#acc10fe8e7d97d6ac8fa010c1f9a3e958">CircularBuffer::get</a></div><div class="ttdeci">T * get(const uint8_t idx) const</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:177</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a6b4c589e1ab60eee457bdfb5e4766c46"><div class="ttname"><a href="class_circular_buffer.html#a6b4c589e1ab60eee457bdfb5e4766c46">CircularBuffer::m_size</a></div><div class="ttdeci">const uint8_t m_size</div><div class="ttdoc">Total number of records that can be stored in the buffer.</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:191</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a4fed074db05fe6a5a2ec232f975a66c9"><div class="ttname"><a href="class_circular_buffer.html#a4fed074db05fe6a5a2ec232f975a66c9">CircularBuffer::popBack</a></div><div class="ttdeci">bool popBack(void)</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:159</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a4ae7d8486d1535f5f64b8a7f955a5309"><div class="ttname"><a href="class_circular_buffer.html#a4ae7d8486d1535f5f64b8a7f955a5309">CircularBuffer::m_buff</a></div><div class="ttdeci">T *const m_buff</div><div class="ttdoc">Ptr to buffer holding all records.</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:192</div></div>
<div class="ttc" id="aclass_circular_buffer_html_af64f94ddb7657c23ad232bec4b1de282"><div class="ttname"><a href="class_circular_buffer.html#af64f94ddb7657c23ad232bec4b1de282">CircularBuffer::pushFront</a></div><div class="ttdeci">bool pushFront(T *record)</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:121</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a0d2a01a1ff8feab686130b1a82de5838"><div class="ttname"><a href="class_circular_buffer.html#a0d2a01a1ff8feab686130b1a82de5838">CircularBuffer::m_front</a></div><div class="ttdeci">volatile uint8_t m_front</div><div class="ttdoc">Index of front element (not pushed yet).</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:193</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a8f6cfb9986df3cb77d89615709370767"><div class="ttname"><a href="class_circular_buffer.html#a8f6cfb9986df3cb77d89615709370767">CircularBuffer::getFront</a></div><div class="ttdeci">T * getFront(void) const</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:104</div></div>
<div class="ttc" id="aclass_circular_buffer_html_af3817fe2936df567836c0c1d6a25caea"><div class="ttname"><a href="class_circular_buffer.html#af3817fe2936df567836c0c1d6a25caea">CircularBuffer::m_fill</a></div><div class="ttdeci">volatile uint8_t m_fill</div><div class="ttdoc">Amount of records currently pushed.</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:194</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a423f9f79766010b2c47502bf2f584018"><div class="ttname"><a href="class_circular_buffer.html#a423f9f79766010b2c47502bf2f584018">CircularBuffer::available</a></div><div class="ttdeci">uint8_t available(void) const</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:89</div></div>
<div class="ttc" id="aclass_circular_buffer_html_a501b884153e525a38724c5299243afd9"><div class="ttname"><a href="class_circular_buffer.html#a501b884153e525a38724c5299243afd9">CircularBuffer::getBack</a></div><div class="ttdeci">T * getBack(void) const</div><div class="ttdef"><b>Definition:</b> CircularBuffer.h:144</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>