Willkommen bei WordPress. Dies ist dein erster Beitrag. Bearbeite oder lösche ihn und beginne mit dem Schreiben!
Hallo Welt!
von raredesign | Dez 3, 2019 | Allgemein | 0 Kommentare
Cokiee Shell
| Current Path : /proc/self/root/usr/share/doc/libclam-doc/html/ |
| Current File : //proc/self/root/usr/share/doc/libclam-doc/html/classCLAM_1_1CircularBuffer.html |
<!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"/>
<title>CLAM-Development: CLAM::CircularBuffer< 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="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">CLAM-Development
 <span id="projectnumber">1.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCLAM.html">CLAM</a></li><li class="navelem"><a class="el" href="classCLAM_1_1CircularBuffer.html">CircularBuffer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CLAM::CircularBuffer< T > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Generic container-like circular buffer class.
<a href="classCLAM_1_1CircularBuffer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>></code></p>
<p><a href="classCLAM_1_1CircularBuffer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0bec01c6a806041d4f1b583880e06bab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a0bec01c6a806041d4f1b583880e06bab">CircularBuffer</a> ()</td></tr>
<tr class="memdesc:a0bec01c6a806041d4f1b583880e06bab"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a0bec01c6a806041d4f1b583880e06bab"></a><br/></td></tr>
<tr class="memitem:afd909b03ce941703bef10e5df425ba62"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#afd909b03ce941703bef10e5df425ba62">CircularBuffer</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> bufferSize)</td></tr>
<tr class="memdesc:afd909b03ce941703bef10e5df425ba62"><td class="mdescLeft"> </td><td class="mdescRight">Constructor which initializes the buffer to a certain capacity. <a href="#afd909b03ce941703bef10e5df425ba62"></a><br/></td></tr>
<tr class="memitem:aff5abbcaa812c6a39ca5705f9a6d9d17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aff5abbcaa812c6a39ca5705f9a6d9d17">GetBufferSize</a> () const </td></tr>
<tr class="memdesc:aff5abbcaa812c6a39ca5705f9a6d9d17"><td class="mdescLeft"> </td><td class="mdescRight">Returns the circular buffer's buffer size. <a href="#aff5abbcaa812c6a39ca5705f9a6d9d17"></a><br/></td></tr>
<tr class="memitem:a3402381caef191931505558b08d8d6b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3402381caef191931505558b08d8d6b3">SetBufferSize</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr>
<tr class="memdesc:a3402381caef191931505558b08d8d6b3"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the buffer to a new capacity (or buffer size). <a href="#a3402381caef191931505558b08d8d6b3"></a><br/></td></tr>
<tr class="memitem:aa3abc4c0bf9494963b441fac7b8b3687"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aa3abc4c0bf9494963b441fac7b8b3687">GetWriteIndex</a> () const </td></tr>
<tr class="memdesc:aa3abc4c0bf9494963b441fac7b8b3687"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the element that the buffer is about to write (ie. <a href="#aa3abc4c0bf9494963b441fac7b8b3687"></a><br/></td></tr>
<tr class="memitem:af9195fed9740bbaf2392125ba9f4cf8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#af9195fed9740bbaf2392125ba9f4cf8a">GetReadIndex</a> () const </td></tr>
<tr class="memdesc:af9195fed9740bbaf2392125ba9f4cf8a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the element that the buffer is about to read (ie. <a href="#af9195fed9740bbaf2392125ba9f4cf8a"></a><br/></td></tr>
<tr class="memitem:a85009cd1d2b52cdc3592d6a2abc98611"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a85009cd1d2b52cdc3592d6a2abc98611">GetInitialReadOffset</a> () const </td></tr>
<tr class="memdesc:a85009cd1d2b52cdc3592d6a2abc98611"><td class="mdescLeft"> </td><td class="mdescRight">Returns the initial read offset. <a href="#a85009cd1d2b52cdc3592d6a2abc98611"></a><br/></td></tr>
<tr class="memitem:a298d0d12e31a9b7271a95e7c05a8afec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a298d0d12e31a9b7271a95e7c05a8afec">SetInitialReadOffset</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr>
<tr class="memdesc:a298d0d12e31a9b7271a95e7c05a8afec"><td class="mdescLeft"> </td><td class="mdescRight">Sets the initial read offset. <a href="#a298d0d12e31a9b7271a95e7c05a8afec"></a><br/></td></tr>
<tr class="memitem:a4fb8b631ccefdfae6650d6fa54712fc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a4fb8b631ccefdfae6650d6fa54712fc0">GetInitialWriteOffset</a> () const </td></tr>
<tr class="memdesc:a4fb8b631ccefdfae6650d6fa54712fc0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the initial write offset. <a href="#a4fb8b631ccefdfae6650d6fa54712fc0"></a><br/></td></tr>
<tr class="memitem:a5fc86980afc639c74b8b90c5e824ccea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a5fc86980afc639c74b8b90c5e824ccea">SetInitialWriteOffset</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr>
<tr class="memdesc:a5fc86980afc639c74b8b90c5e824ccea"><td class="mdescLeft"> </td><td class="mdescRight">Sets the initial write offset. <a href="#a5fc86980afc639c74b8b90c5e824ccea"></a><br/></td></tr>
<tr class="memitem:a6acb84ac743637b2cb4c799013de6e43"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a6acb84ac743637b2cb4c799013de6e43">Init</a> ()</td></tr>
<tr class="memdesc:a6acb84ac743637b2cb4c799013de6e43"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the buffer by setting all elements to 0 and making sure read/write indices are set correctly (taking into account initial read/write offsets). <a href="#a6acb84ac743637b2cb4c799013de6e43"></a><br/></td></tr>
<tr class="memitem:aeaad04e0acc435e35764aec2506b14ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aeaad04e0acc435e35764aec2506b14ec">SetBufferToZero</a> ()</td></tr>
<tr class="memdesc:aeaad04e0acc435e35764aec2506b14ec"><td class="mdescLeft"> </td><td class="mdescRight">Sets all elements in circular buffer to zero. <a href="#aeaad04e0acc435e35764aec2506b14ec"></a><br/></td></tr>
<tr class="memitem:a43f7ca5e654b0cb9d4cb848035f8b814"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a43f7ca5e654b0cb9d4cb848035f8b814">InitPointers</a> ()</td></tr>
<tr class="memdesc:a43f7ca5e654b0cb9d4cb848035f8b814"><td class="mdescLeft"> </td><td class="mdescRight">Initializes read/write indices (taking into account initial read/write offsets). <a href="#a43f7ca5e654b0cb9d4cb848035f8b814"></a><br/></td></tr>
<tr class="memitem:abaacb419d16e7e97eb505765ca7e0b1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#abaacb419d16e7e97eb505765ca7e0b1b">Read</a> (T &element)</td></tr>
<tr class="memdesc:abaacb419d16e7e97eb505765ca7e0b1b"><td class="mdescLeft"> </td><td class="mdescRight">Reads a single element at the current read index into element. <a href="#abaacb419d16e7e97eb505765ca7e0b1b"></a><br/></td></tr>
<tr class="memitem:ac4fb08f27529f4961ab657cbcd143931"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac4fb08f27529f4961ab657cbcd143931">NonCopyRead</a> (<a class="el" href="classCLAM_1_1Array.html">Array</a>< T > &buffer)</td></tr>
<tr class="memitem:a6b740b3d393000ef762574022e4a2241"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a6b740b3d393000ef762574022e4a2241">Read</a> (T *buffer)</td></tr>
<tr class="memdesc:a6b740b3d393000ef762574022e4a2241"><td class="mdescLeft"> </td><td class="mdescRight">Reads read size number of elements starting at the current read index into buffer. <a href="#a6b740b3d393000ef762574022e4a2241"></a><br/></td></tr>
<tr class="memitem:ac8f6c0843e1bc7a730848ac8b5316a8d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac8f6c0843e1bc7a730848ac8b5316a8d">Read</a> (<a class="el" href="classCLAM_1_1Array.html">Array</a>< T > &in, <a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> offset=0)</td></tr>
<tr class="memdesc:ac8f6c0843e1bc7a730848ac8b5316a8d"><td class="mdescLeft"> </td><td class="mdescRight">Reads read size number of elements starting at the current read index into the array at the specified offset (default: offset = 0). <a href="#ac8f6c0843e1bc7a730848ac8b5316a8d"></a><br/></td></tr>
<tr class="memitem:a641ad296ff574c8a64bf816ace3d697a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a641ad296ff574c8a64bf816ace3d697a">Write</a> (const T &element)</td></tr>
<tr class="memdesc:a641ad296ff574c8a64bf816ace3d697a"><td class="mdescLeft"> </td><td class="mdescRight">Writes a single element at the current write index. <a href="#a641ad296ff574c8a64bf816ace3d697a"></a><br/></td></tr>
<tr class="memitem:a79b46c715ea76a0145564f364b9958b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a79b46c715ea76a0145564f364b9958b8">Write</a> (const T *buffer)</td></tr>
<tr class="memdesc:a79b46c715ea76a0145564f364b9958b8"><td class="mdescLeft"> </td><td class="mdescRight">Writes write size number of elements starting at the current write index from buffer. <a href="#a79b46c715ea76a0145564f364b9958b8"></a><br/></td></tr>
<tr class="memitem:ac22ad20143590b20c3832753d4fee70d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac22ad20143590b20c3832753d4fee70d">Write</a> (const <a class="el" href="classCLAM_1_1Array.html">Array</a>< T > &in, <a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> offset=0)</td></tr>
<tr class="memdesc:ac22ad20143590b20c3832753d4fee70d"><td class="mdescLeft"> </td><td class="mdescRight">Writes write size number of elements starting at the current write index from the array starting at the specified offset (default: offset = 0). <a href="#ac22ad20143590b20c3832753d4fee70d"></a><br/></td></tr>
<tr class="memitem:a260bbca271368a440868d13ebe50ccea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a260bbca271368a440868d13ebe50ccea">Add</a> (const T &elem)</td></tr>
<tr class="memdesc:a260bbca271368a440868d13ebe50ccea"><td class="mdescLeft"> </td><td class="mdescRight">Does an additive write of a single element at the current write index. <a href="#a260bbca271368a440868d13ebe50ccea"></a><br/></td></tr>
<tr class="memitem:a3366c033d501973545e1991b94fc9ddc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3366c033d501973545e1991b94fc9ddc">Add</a> (const <a class="el" href="classCLAM_1_1Array.html">Array</a>< T > &in, <a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> offset=0)</td></tr>
<tr class="memdesc:a3366c033d501973545e1991b94fc9ddc"><td class="mdescLeft"> </td><td class="mdescRight">Does an additive write of write size number of elements at the current write index onwards from the specified input array starting at the specified offset (default: offset = 0) onwards. <a href="#a3366c033d501973545e1991b94fc9ddc"></a><br/></td></tr>
<tr class="memitem:ae9c0fc10ec0eb410bc738bb064d9e0c7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ae9c0fc10ec0eb410bc738bb064d9e0c7">IncreaseReadIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr>
<tr class="memdesc:ae9c0fc10ec0eb410bc738bb064d9e0c7"><td class="mdescLeft"> </td><td class="mdescRight">Increases the read index by the specified number of elements (default: step = 1). <a href="#ae9c0fc10ec0eb410bc738bb064d9e0c7"></a><br/></td></tr>
<tr class="memitem:a7f71b522b698250ad1a6bf6d379c712a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a7f71b522b698250ad1a6bf6d379c712a">IncreaseWriteIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr>
<tr class="memdesc:a7f71b522b698250ad1a6bf6d379c712a"><td class="mdescLeft"> </td><td class="mdescRight">Increases the write index by the specified number of elements (default: step = 1). <a href="#a7f71b522b698250ad1a6bf6d379c712a"></a><br/></td></tr>
<tr class="memitem:aeee61bb455b27e630a1b04507b8ce1d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#aeee61bb455b27e630a1b04507b8ce1d5">DecreaseReadIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr>
<tr class="memdesc:aeee61bb455b27e630a1b04507b8ce1d5"><td class="mdescLeft"> </td><td class="mdescRight">Decreases the read index by the specified number of elements (default: step = 1). <a href="#aeee61bb455b27e630a1b04507b8ce1d5"></a><br/></td></tr>
<tr class="memitem:ae53ac4051e2d00009129e682ed969174"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ae53ac4051e2d00009129e682ed969174">DecreaseWriteIndex</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> step=1)</td></tr>
<tr class="memdesc:ae53ac4051e2d00009129e682ed969174"><td class="mdescLeft"> </td><td class="mdescRight">Decreases the write index by the specified number of elements (default: step = 1). <a href="#ae53ac4051e2d00009129e682ed969174"></a><br/></td></tr>
<tr class="memitem:af411e6bfe027869a166839e99e06af2f"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#af411e6bfe027869a166839e99e06af2f">GetPtrToElement</a> (<a class="el" href="classint.html">int</a> absPos)</td></tr>
<tr class="memdesc:af411e6bfe027869a166839e99e06af2f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer (well, reference) to the element at the specified index. <a href="#af411e6bfe027869a166839e99e06af2f"></a><br/></td></tr>
<tr class="memitem:a7189515bca76461f0b7c926f0587ab95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a7189515bca76461f0b7c926f0587ab95">GetReadSize</a> () const </td></tr>
<tr class="memdesc:a7189515bca76461f0b7c926f0587ab95"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current read size. <a href="#a7189515bca76461f0b7c926f0587ab95"></a><br/></td></tr>
<tr class="memitem:ac1ba0b92a96b99d758331a8fcc6c6779"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac1ba0b92a96b99d758331a8fcc6c6779">GetWriteSize</a> () const </td></tr>
<tr class="memdesc:ac1ba0b92a96b99d758331a8fcc6c6779"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current write size. <a href="#ac1ba0b92a96b99d758331a8fcc6c6779"></a><br/></td></tr>
<tr class="memitem:a3c7946c7eb92d3d00cebea6db80333d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3c7946c7eb92d3d00cebea6db80333d7">SetReadSize</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr>
<tr class="memdesc:a3c7946c7eb92d3d00cebea6db80333d7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the read size. <a href="#a3c7946c7eb92d3d00cebea6db80333d7"></a><br/></td></tr>
<tr class="memitem:a7cc189dccc0aadd63a7e1a503d211c52"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a7cc189dccc0aadd63a7e1a503d211c52">SetWriteSize</a> (<a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> size)</td></tr>
<tr class="memdesc:a7cc189dccc0aadd63a7e1a503d211c52"><td class="mdescLeft"> </td><td class="mdescRight">Sets the write size. <a href="#a7cc189dccc0aadd63a7e1a503d211c52"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a40b02668c80704b8332b0f443d98a526"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCLAM_1_1Array.html">Array</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a40b02668c80704b8332b0f443d98a526">mBuffer</a></td></tr>
<tr class="memitem:a4f93010a72621051377ee8931f5aedc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a4f93010a72621051377ee8931f5aedc0">mLogicalSize</a></td></tr>
<tr class="memitem:a3c5e504acd155f7c995d6c771338232a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a3c5e504acd155f7c995d6c771338232a">mReadSize</a></td></tr>
<tr class="memitem:a29904a4ee1925b6253f1ed25eef0910c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a29904a4ee1925b6253f1ed25eef0910c">mWriteSize</a></td></tr>
<tr class="memitem:a8f860fa199c23eadd04d205f174ca84f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a8f860fa199c23eadd04d205f174ca84f">mWriteIndex</a></td></tr>
<tr class="memitem:ac7a9b326505f673d8c2db03eeb1bc6c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#ac7a9b326505f673d8c2db03eeb1bc6c7">mReadIndex</a></td></tr>
<tr class="memitem:abac65c1073d86000c07a1b60e3c5d172"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#abac65c1073d86000c07a1b60e3c5d172">mInitialReadOffset</a></td></tr>
<tr class="memitem:a4370aa4a8f4a685997c6388156343494"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCLAM_1_1CircularBuffer.html#a4370aa4a8f4a685997c6388156343494">mInitialWriteOffset</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class T><br/>
class CLAM::CircularBuffer< T ></h3>
<p>Generic container-like circular buffer class. </p>
<p>It can be pre-allocated to a certain capacity and resized at any time (not while doing concurrent reading/writing). This circular buffer is not thread-safe. You can either read/write single elements at a time or read/write in blocks. The size of these blocks is specified the read size and write size respectively. The circular buffer must be initialized (by calling <a class="el" href="classCLAM_1_1CircularBuffer.html#a6acb84ac743637b2cb4c799013de6e43" title="Initializes the buffer by setting all elements to 0 and making sure read/write indices are set correc...">Init()</a>) prior to being used. An initial read offset can be specified which indicates the index at which the buffer starts reading after it's been initialized (default: 0). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00046">46</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0bec01c6a806041d4f1b583880e06bab"></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="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::<a class="el" href="classCLAM_1_1CircularBuffer.html">CircularBuffer</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">
<p>Default constructor. </p>
<p>Read and write indices will be initialized to 0. Read and write sizes will be initialized to 1. Initial read and write offsets will be initialized to 0. The buffer size will be 0. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00066">66</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="afd909b03ce941703bef10e5df425ba62"></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="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::<a class="el" href="classCLAM_1_1CircularBuffer.html">CircularBuffer</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>bufferSize</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">
<p>Constructor which initializes the buffer to a certain capacity. </p>
<p>This capacity (or buffer size) can be arbitrary (not power-of-two, etc), but must be greater than 0. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00082">82</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a260bbca271368a440868d13ebe50ccea"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::<a class="el" href="classCLAM_1_1Add.html">Add</a> </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>elem</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">
<p>Does an additive write of a single element at the current write index. </p>
<p>It 'mixes' the old element's content with the new one. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00347">347</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00360">CLAM::CircularBuffer< TData >::Add()</a>.</p>
</div>
</div>
<a class="anchor" id="a3366c033d501973545e1991b94fc9ddc"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::<a class="el" href="classCLAM_1_1Add.html">Add</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCLAM_1_1Array.html">Array</a>< T > & </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>offset</em> = <code>0</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">
<p>Does an additive write of write size number of elements at the current write index onwards from the specified input array starting at the specified offset (default: offset = 0) onwards. </p>
<p><a class="el" href="classCLAM_1_1Note.html" title="Used to store note information.">Note</a>: not very efficient. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00360">360</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="aeee61bb455b27e630a1b04507b8ce1d5"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::DecreaseReadIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>step</em> = <code>1</code></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>Decreases the read index by the specified number of elements (default: step = 1). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00397">397</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="ae53ac4051e2d00009129e682ed969174"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::DecreaseWriteIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>step</em> = <code>1</code></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>Decreases the write index by the specified number of elements (default: step = 1). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00411">411</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="aff5abbcaa812c6a39ca5705f9a6d9d17"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetBufferSize </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>Returns the circular buffer's buffer size. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00099">99</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00397">CLAM::CircularBuffer< TData >::DecreaseReadIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00411">CLAM::CircularBuffer< TData >::DecreaseWriteIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00426">CLAM::CircularBuffer< TData >::GetPtrToElement()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00372">CLAM::CircularBuffer< TData >::IncreaseReadIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00384">CLAM::CircularBuffer< TData >::IncreaseWriteIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00207">CLAM::CircularBuffer< TData >::InitPointers()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00233">CLAM::CircularBuffer< TData >::NonCopyRead()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00253">CLAM::CircularBuffer< TData >::Read()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00196">CLAM::CircularBuffer< TData >::SetBufferToZero()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00150">CLAM::CircularBuffer< TData >::SetInitialReadOffset()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00173">CLAM::CircularBuffer< TData >::SetInitialWriteOffset()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00459">CLAM::CircularBuffer< TData >::SetReadSize()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00471">CLAM::CircularBuffer< TData >::SetWriteSize()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00306">CLAM::CircularBuffer< TData >::Write()</a>.</p>
</div>
</div>
<a class="anchor" id="a85009cd1d2b52cdc3592d6a2abc98611"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetInitialReadOffset </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>Returns the initial read offset. </p>
<p>That is, the index at which the buffer starts reading after it has been initialized. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00139">139</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a4fb8b631ccefdfae6650d6fa54712fc0"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetInitialWriteOffset </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>Returns the initial write offset. </p>
<p>That is, the index at which the buffer starts writeing after it has been initialized. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00162">162</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="af411e6bfe027869a166839e99e06af2f"></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">T& <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetPtrToElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classint.html">int</a> </td>
<td class="paramname"><em>absPos</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">
<p>Returns a pointer (well, reference) to the element at the specified index. </p>
<p>If the specified index is out of bounds it will 'wrap-around'. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00426">426</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="af9195fed9740bbaf2392125ba9f4cf8a"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetReadIndex </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>Returns the index of the element that the buffer is about to read (ie. </p>
<p>on the next read-like call). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00129">129</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a7189515bca76461f0b7c926f0587ab95"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetReadSize </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>Returns the current read size. </p>
<p>The read size determines how many elements will read at once when doing 'chunk' reads. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00440">440</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00099">CLAM::CircularBuffer< TData >::GetBufferSize()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00280">CLAM::CircularBuffer< TData >::Read()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00109">CLAM::CircularBuffer< TData >::SetBufferSize()</a>.</p>
</div>
</div>
<a class="anchor" id="aa3abc4c0bf9494963b441fac7b8b3687"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetWriteIndex </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>Returns the index of the element that the buffer is about to write (ie. </p>
<p>on the next write-like call). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00120">120</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="ac1ba0b92a96b99d758331a8fcc6c6779"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::GetWriteSize </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>Returns the current write size. </p>
<p>The write size determines how many elements will be written at once when doing 'chunk' writes. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00450">450</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00360">CLAM::CircularBuffer< TData >::Add()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00331">CLAM::CircularBuffer< TData >::Write()</a>.</p>
</div>
</div>
<a class="anchor" id="ae9c0fc10ec0eb410bc738bb064d9e0c7"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::IncreaseReadIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>step</em> = <code>1</code></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>Increases the read index by the specified number of elements (default: step = 1). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00372">372</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00233">CLAM::CircularBuffer< TData >::NonCopyRead()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00226">CLAM::CircularBuffer< TData >::Read()</a>.</p>
</div>
</div>
<a class="anchor" id="a7f71b522b698250ad1a6bf6d379c712a"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::IncreaseWriteIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>step</em> = <code>1</code></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>Increases the write index by the specified number of elements (default: step = 1). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00384">384</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00347">CLAM::CircularBuffer< TData >::Add()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00295">CLAM::CircularBuffer< TData >::Write()</a>.</p>
</div>
</div>
<a class="anchor" id="a6acb84ac743637b2cb4c799013de6e43"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::Init </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>Initializes the buffer by setting all elements to 0 and making sure read/write indices are set correctly (taking into account initial read/write offsets). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00187">187</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a43f7ca5e654b0cb9d4cb848035f8b814"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::InitPointers </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>Initializes read/write indices (taking into account initial read/write offsets). </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00207">207</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00187">CLAM::CircularBuffer< TData >::Init()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00109">CLAM::CircularBuffer< TData >::SetBufferSize()</a>.</p>
</div>
</div>
<a class="anchor" id="ac4fb08f27529f4961ab657cbcd143931"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::NonCopyRead </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCLAM_1_1Array.html">Array</a>< T > & </td>
<td class="paramname"><em>buffer</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">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00233">233</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="abaacb419d16e7e97eb505765ca7e0b1b"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::Read </td>
<td>(</td>
<td class="paramtype">T & </td>
<td class="paramname"><em>element</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">
<p>Reads a single element at the current read index into element. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00226">226</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00280">CLAM::CircularBuffer< TData >::Read()</a>.</p>
</div>
</div>
<a class="anchor" id="a6b740b3d393000ef762574022e4a2241"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::Read </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>buffer</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">
<p>Reads read size number of elements starting at the current read index into buffer. </p>
<p>If the read size + read index is out of bounds (ie. past the end of the buffer) the reading will 'wrap-around'. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00253">253</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="ac8f6c0843e1bc7a730848ac8b5316a8d"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::Read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCLAM_1_1Array.html">Array</a>< T > & </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>offset</em> = <code>0</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">
<p>Reads read size number of elements starting at the current read index into the array at the specified offset (default: offset = 0). </p>
<p>The destination array must be large enough to hold read size number of elements at the specified offset. If reading is out of bounds it will wrap-around. <a class="el" href="classCLAM_1_1Note.html" title="Used to store note information.">Note</a>: define CLAM_HIGH_OPTIMIZATIONS for this function to be efficient. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00280">280</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a3402381caef191931505558b08d8d6b3"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::SetBufferSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>size</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">
<p>Resizes the buffer to a new capacity (or buffer size). </p>
<p>This capacity (or buffer size) can be arbitrary (not power-of-two, etc). If size is set to 0 or less the buffer will be deallocated. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00109">109</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00459">CLAM::CircularBuffer< TData >::SetReadSize()</a>.</p>
</div>
</div>
<a class="anchor" id="aeaad04e0acc435e35764aec2506b14ec"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::SetBufferToZero </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>Sets all elements in circular buffer to zero. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00196">196</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00187">CLAM::CircularBuffer< TData >::Init()</a>.</p>
</div>
</div>
<a class="anchor" id="a298d0d12e31a9b7271a95e7c05a8afec"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::SetInitialReadOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>size</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">
<p>Sets the initial read offset. </p>
<p>That is, the index at which the buffer starts reading after it has been initialized. <a class="el" href="classCLAM_1_1CircularBuffer.html#a6acb84ac743637b2cb4c799013de6e43" title="Initializes the buffer by setting all elements to 0 and making sure read/write indices are set correc...">Init()</a> or <a class="el" href="classCLAM_1_1CircularBuffer.html#a43f7ca5e654b0cb9d4cb848035f8b814" title="Initializes read/write indices (taking into account initial read/write offsets).">InitPointers()</a> should be called after this method. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00150">150</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a5fc86980afc639c74b8b90c5e824ccea"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::SetInitialWriteOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>size</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">
<p>Sets the initial write offset. </p>
<p>That is, the index at which the buffer starts writeing after it has been initialized. <a class="el" href="classCLAM_1_1CircularBuffer.html#a6acb84ac743637b2cb4c799013de6e43" title="Initializes the buffer by setting all elements to 0 and making sure read/write indices are set correc...">Init()</a> or <a class="el" href="classCLAM_1_1CircularBuffer.html#a43f7ca5e654b0cb9d4cb848035f8b814" title="Initializes read/write indices (taking into account initial read/write offsets).">InitPointers()</a> should be called after this method. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00173">173</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a3c7946c7eb92d3d00cebea6db80333d7"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::SetReadSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>size</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">
<p>Sets the read size. </p>
<p>This read size must be greater than or equal to 0 and less than or equal to the buffer size. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00459">459</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a7cc189dccc0aadd63a7e1a503d211c52"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::SetWriteSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>size</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">
<p>Sets the write size. </p>
<p>This write size must be greater than or equal to 0 and less than or equal to the buffer size. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00471">471</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="a641ad296ff574c8a64bf816ace3d697a"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::Write </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>element</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">
<p>Writes a single element at the current write index. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00295">295</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00331">CLAM::CircularBuffer< TData >::Write()</a>.</p>
</div>
</div>
<a class="anchor" id="a79b46c715ea76a0145564f364b9958b8"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::Write </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>buffer</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">
<p>Writes write size number of elements starting at the current write index from buffer. </p>
<p>If it must write out of bounds, it will 'wrap-around'. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00306">306</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<a class="anchor" id="ac22ad20143590b20c3832753d4fee70d"></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">void <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::Write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCLAM_1_1Array.html">Array</a>< T > & </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> </td>
<td class="paramname"><em>offset</em> = <code>0</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">
<p>Writes write size number of elements starting at the current write index from the array starting at the specified offset (default: offset = 0). </p>
<p>The input array must have atleast write size number of elements from the specified offset onwards. <a class="el" href="classCLAM_1_1Note.html" title="Used to store note information.">Note</a>: define CLAM_HIGH_OPTIMIZATIONS for this method to be efficient. </p>
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00331">331</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a40b02668c80704b8332b0f443d98a526"></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="classCLAM_1_1Array.html">Array</a><T> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mBuffer</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00049">49</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00347">CLAM::CircularBuffer< TData >::Add()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00099">CLAM::CircularBuffer< TData >::GetBufferSize()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00426">CLAM::CircularBuffer< TData >::GetPtrToElement()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00233">CLAM::CircularBuffer< TData >::NonCopyRead()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00226">CLAM::CircularBuffer< TData >::Read()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00109">CLAM::CircularBuffer< TData >::SetBufferSize()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00196">CLAM::CircularBuffer< TData >::SetBufferToZero()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00295">CLAM::CircularBuffer< TData >::Write()</a>.</p>
</div>
</div>
<a class="anchor" id="abac65c1073d86000c07a1b60e3c5d172"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mInitialReadOffset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00055">55</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00139">CLAM::CircularBuffer< TData >::GetInitialReadOffset()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00207">CLAM::CircularBuffer< TData >::InitPointers()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00150">CLAM::CircularBuffer< TData >::SetInitialReadOffset()</a>.</p>
</div>
</div>
<a class="anchor" id="a4370aa4a8f4a685997c6388156343494"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mInitialWriteOffset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00056">56</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00162">CLAM::CircularBuffer< TData >::GetInitialWriteOffset()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00207">CLAM::CircularBuffer< TData >::InitPointers()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00173">CLAM::CircularBuffer< TData >::SetInitialWriteOffset()</a>.</p>
</div>
</div>
<a class="anchor" id="a4f93010a72621051377ee8931f5aedc0"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mLogicalSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00050">50</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00397">CLAM::CircularBuffer< TData >::DecreaseReadIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00411">CLAM::CircularBuffer< TData >::DecreaseWriteIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00372">CLAM::CircularBuffer< TData >::IncreaseReadIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00384">CLAM::CircularBuffer< TData >::IncreaseWriteIndex()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00207">CLAM::CircularBuffer< TData >::InitPointers()</a>.</p>
</div>
</div>
<a class="anchor" id="ac7a9b326505f673d8c2db03eeb1bc6c7"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mReadIndex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00054">54</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00397">CLAM::CircularBuffer< TData >::DecreaseReadIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00129">CLAM::CircularBuffer< TData >::GetReadIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00372">CLAM::CircularBuffer< TData >::IncreaseReadIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00207">CLAM::CircularBuffer< TData >::InitPointers()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00233">CLAM::CircularBuffer< TData >::NonCopyRead()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00226">CLAM::CircularBuffer< TData >::Read()</a>.</p>
</div>
</div>
<a class="anchor" id="a3c5e504acd155f7c995d6c771338232a"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mReadSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00051">51</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00440">CLAM::CircularBuffer< TData >::GetReadSize()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00233">CLAM::CircularBuffer< TData >::NonCopyRead()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00253">CLAM::CircularBuffer< TData >::Read()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00459">CLAM::CircularBuffer< TData >::SetReadSize()</a>.</p>
</div>
</div>
<a class="anchor" id="a8f860fa199c23eadd04d205f174ca84f"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mWriteIndex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00053">53</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00347">CLAM::CircularBuffer< TData >::Add()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00411">CLAM::CircularBuffer< TData >::DecreaseWriteIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00120">CLAM::CircularBuffer< TData >::GetWriteIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00384">CLAM::CircularBuffer< TData >::IncreaseWriteIndex()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00207">CLAM::CircularBuffer< TData >::InitPointers()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00295">CLAM::CircularBuffer< TData >::Write()</a>.</p>
</div>
</div>
<a class="anchor" id="a29904a4ee1925b6253f1ed25eef0910c"></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="namespaceCLAM.html#a33598bc354b7042bc0d6529a155937a7">TSize</a> <a class="el" href="classCLAM_1_1CircularBuffer.html">CLAM::CircularBuffer</a>< T >::mWriteSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="CircularBuffer_8hxx_source.html#l00052">52</a> of file <a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a>.</p>
<p>Referenced by <a class="el" href="CircularBuffer_8hxx_source.html#l00360">CLAM::CircularBuffer< TData >::Add()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00066">CLAM::CircularBuffer< TData >::CircularBuffer()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00450">CLAM::CircularBuffer< TData >::GetWriteSize()</a>, <a class="el" href="CircularBuffer_8hxx_source.html#l00471">CLAM::CircularBuffer< TData >::SetWriteSize()</a>, and <a class="el" href="CircularBuffer_8hxx_source.html#l00306">CLAM::CircularBuffer< TData >::Write()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="CircularBuffer_8hxx_source.html">CircularBuffer.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- 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.1
</small></address>
</body>
</html>
Cokiee Shell Web 1.0, Coded By Razor
Neueste Kommentare