Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_circular_buffer_example.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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"/>
<title>TB9.2 Example Applications: CCircularBufferExample Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CCircularBufferExample Class Reference</h1><!-- doxytag: class="CCircularBufferExample" -->
<p><a href="class_c_circular_buffer_example-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#a186681cb1a9f422e1e00ce27d9bab8d1">~CCircularBufferExample</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#aa197a8d4f8585a4277c286e02dc1d1ce">CircularBufferOfIntsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#a11ec0dc3b7d29955b891a8675bfeb555">CircularBufferOfMyObjectsL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#ac317019ee3a32d5dcef6a90e5a52913c">CircularBufferOfRClasssL</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_circular_buffer_example.html">CCircularBufferExample</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#adb5aee8a165729ff3c4a87fb5fc69426">NewL</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Demonstrates the following uses of the Symbian platform circular buffer API:</p>
<ul>
<li>Creating a circular buffer.</li>
<li>Adding elements to the circular buffer</li>
<li>Removing elements from the circular buffer </li>
</ul>
<p>Definition at line <a class="el" href="circularbuffer_8h_source.html#l00034">34</a> of file <a class="el" href="circularbuffer_8h_source.html">circularbuffer.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a186681cb1a9f422e1e00ce27d9bab8d1"></a><!-- doxytag: member="CCircularBufferExample::~CCircularBufferExample" ref="a186681cb1a9f422e1e00ce27d9bab8d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCircularBufferExample::~CCircularBufferExample </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00087">87</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adb5aee8a165729ff3c4a87fb5fc69426"></a><!-- doxytag: member="CCircularBufferExample::NewL" ref="adb5aee8a165729ff3c4a87fb5fc69426" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_circular_buffer_example.html">CCircularBufferExample</a> * CCircularBufferExample::NewL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocates and constructs a <a class="el" href="class_c_circular_buffer_example.html">CCircularBufferExample</a> object. Initialises all member data to their default values. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_circular_buffer_example.html">CCircularBufferExample</a> object. </dd></dl>
<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00097">97</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa197a8d4f8585a4277c286e02dc1d1ce"></a><!-- doxytag: member="CCircularBufferExample::CircularBufferOfIntsL" ref="aa197a8d4f8585a4277c286e02dc1d1ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCircularBufferExample::CircularBufferOfIntsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a circular buffer containing integers, and adds and removes integers. </p>
<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00108">108</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a11ec0dc3b7d29955b891a8675bfeb555"></a><!-- doxytag: member="CCircularBufferExample::CircularBufferOfMyObjectsL" ref="a11ec0dc3b7d29955b891a8675bfeb555" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCircularBufferExample::CircularBufferOfMyObjectsL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a circular buffer of objects of my own created class, add and remove object from buffer. </p>
<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00215">215</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac317019ee3a32d5dcef6a90e5a52913c"></a><!-- doxytag: member="CCircularBufferExample::CircularBufferOfRClasssL" ref="ac317019ee3a32d5dcef6a90e5a52913c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCircularBufferExample::CircularBufferOfRClasssL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a circular buffer of RBuf objects. </p>
<p>Definition at line <a class="el" href="circularbuffer_8cpp_source.html#l00326">326</a> of file <a class="el" href="circularbuffer_8cpp_source.html">circularbuffer.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>