Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_circular_buffer_example.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CCircularBufferExample Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CCircularBufferExample Class Reference</h1><!-- doxytag: class="CCircularBufferExample" -->
<p>
<a href="class_c_circular_buffer_example-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#186681cb1a9f422e1e00ce27d9bab8d1">~CCircularBufferExample</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#a197a8d4f8585a4277c286e02dc1d1ce">CircularBufferOfIntsL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#11ec0dc3b7d29955b891a8675bfeb555">CircularBufferOfMyObjectsL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_circular_buffer_example.html#c317019ee3a32d5dcef6a90e5a52913c">CircularBufferOfRClasssL</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
<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#db5aee8a165729ff3c4a87fb5fc69426">NewL</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
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" name="186681cb1a9f422e1e00ce27d9bab8d1"></a><!-- doxytag: member="CCircularBufferExample::~CCircularBufferExample" ref="186681cb1a9f422e1e00ce27d9bab8d1" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
<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><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="db5aee8a165729ff3c4a87fb5fc69426"></a><!-- doxytag: member="CCircularBufferExample::NewL" ref="db5aee8a165729ff3c4a87fb5fc69426" 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 width="100%"><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. <dl class="return" compact><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><p>
<a class="anchor" name="a197a8d4f8585a4277c286e02dc1d1ce"></a><!-- doxytag: member="CCircularBufferExample::CircularBufferOfIntsL" ref="a197a8d4f8585a4277c286e02dc1d1ce" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a circular buffer containing integers, and adds and removes integers.
<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><p>
<a class="anchor" name="11ec0dc3b7d29955b891a8675bfeb555"></a><!-- doxytag: member="CCircularBufferExample::CircularBufferOfMyObjectsL" ref="11ec0dc3b7d29955b891a8675bfeb555" 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 width="100%"></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>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><p>
<a class="anchor" name="c317019ee3a32d5dcef6a90e5a52913c"></a><!-- doxytag: member="CCircularBufferExample::CircularBufferOfRClasssL" ref="c317019ee3a32d5dcef6a90e5a52913c" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a circular buffer of RBuf objects.
<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><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>