Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/circularbuffer_8cpp-source.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: examples/Base/BufsAndStrings/circularbufferexample/circularbuffer.cpp Source File</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>examples/Base/BufsAndStrings/circularbufferexample/circularbuffer.cpp</h1><a href="circularbuffer_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">// This example program demonstrates the circular buffer API.</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017
<a name="l00018"></a>00018
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="circularbuffer_8h.html">circularbuffer.h</a>"</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="comment">// Literals.</span>
<a name="l00025"></a>00025 _LIT(KPressAKey, <span class="stringliteral">"\n\tPress any key to continue...."</span>);
<a name="l00026"></a>00026 _LIT(KConstruct,<span class="stringliteral">"\n\n ****Construct****"</span>);
<a name="l00027"></a>00027 _LIT(KAdd,<span class="stringliteral">"\n ****Add objects****\n"</span>);
<a name="l00028"></a>00028 _LIT(KNumberOfObjects,<span class="stringliteral">"\nNumber of objects in the circular buffer: %d\n"</span>);
<a name="l00029"></a>00029 _LIT(KAddFailed,<span class="stringliteral">"\nElement cannot be added because the circular buffer is full\n"</span>);
<a name="l00030"></a>00030 _LIT(KRemove,<span class="stringliteral">"\n ****Remove objects****\n"</span>);
<a name="l00031"></a>00031
<a name="l00032"></a>00032
<a name="l00036"></a><a class="code" href="class_t_my_class.html#0cd85e121a9381570a6e661822e7f328">00036</a> <a class="code" href="class_t_my_class.html#0cd85e121a9381570a6e661822e7f328">TMyClass::TMyClass</a>(){};
<a name="l00040"></a><a class="code" href="class_t_my_class.html#3e3f5a602a8be6eca1be2e6bc9287145">00040</a> <a class="code" href="class_t_my_class.html#0cd85e121a9381570a6e661822e7f328">TMyClass::TMyClass</a>(<span class="keyword">const</span> TDesC& aDes)
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 iBuf = aDes;
<a name="l00043"></a>00043 }
<a name="l00048"></a><a class="code" href="class_t_my_class.html#748ac22426e7695ccfb1af1dd88c96a9">00048</a> <span class="keyword">const</span> TDesC& <a class="code" href="class_t_my_class.html#748ac22426e7695ccfb1af1dd88c96a9">TMyClass::GetBuf</a>()
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 <span class="keywordflow">return</span> iBuf;
<a name="l00051"></a>00051 }
<a name="l00056"></a><a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">00056</a> <span class="keywordtype">void</span> <a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">TMyClass::SetBuf</a>(<span class="keyword">const</span> TDesC& aDes)
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 iBuf = aDes;
<a name="l00059"></a>00059 }
<a name="l00060"></a>00060
<a name="l00064"></a>00064 CCircularBufferExample::CCircularBufferExample()
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 }
<a name="l00067"></a>00067
<a name="l00071"></a>00071 <span class="keywordtype">void</span> CCircularBufferExample::ConstructL()
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 _LIT(KTitle, <span class="stringliteral">"Circular Buffer Example"</span> );
<a name="l00074"></a>00074 iConsole = Console::NewL(KTitle, TSize(KConsFullScreen, KConsFullScreen));
<a name="l00075"></a>00075
<a name="l00076"></a>00076 _LIT(KWelcome, <span class="stringliteral">"\n Welcome to the circular buffer example application"</span>);
<a name="l00077"></a>00077 iConsole->Printf(KWelcome);
<a name="l00078"></a>00078
<a name="l00079"></a>00079 _LIT(KPressAKeyMsg, <span class="stringliteral">"\n\n Press any key to step through the example\n"</span>);
<a name="l00080"></a>00080 iConsole->Printf(KPressAKeyMsg );
<a name="l00081"></a>00081 iConsole->Getch();
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083
<a name="l00087"></a><a class="code" href="class_c_circular_buffer_example.html#186681cb1a9f422e1e00ce27d9bab8d1">00087</a> <a class="code" href="class_c_circular_buffer_example.html#186681cb1a9f422e1e00ce27d9bab8d1">CCircularBufferExample::~CCircularBufferExample</a>()
<a name="l00088"></a>00088 {
<a name="l00089"></a>00089 <span class="keyword">delete</span> iConsole;
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091
<a name="l00097"></a><a class="code" href="class_c_circular_buffer_example.html#db5aee8a165729ff3c4a87fb5fc69426">00097</a> <a class="code" href="class_c_circular_buffer_example.html">CCircularBufferExample</a>* <a class="code" href="class_c_circular_buffer_example.html#db5aee8a165729ff3c4a87fb5fc69426">CCircularBufferExample::NewL</a>()
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099 <a class="code" href="class_c_circular_buffer_example.html">CCircularBufferExample</a>* <span class="keyword">self</span>=<span class="keyword">new</span>(ELeave)<a class="code" href="class_c_circular_buffer_example.html">CCircularBufferExample</a>();
<a name="l00100"></a>00100 CleanupStack::PushL(<span class="keyword">self</span>);
<a name="l00101"></a>00101 <span class="keyword">self</span>->ConstructL();
<a name="l00102"></a>00102 CleanupStack::Pop(<span class="keyword">self</span>);
<a name="l00103"></a>00103 <span class="keywordflow">return</span> <span class="keyword">self</span>;
<a name="l00104"></a>00104 }
<a name="l00108"></a><a class="code" href="class_c_circular_buffer_example.html#a197a8d4f8585a4277c286e02dc1d1ce">00108</a> <span class="keywordtype">void</span> <a class="code" href="class_c_circular_buffer_example.html#a197a8d4f8585a4277c286e02dc1d1ce">CCircularBufferExample::CircularBufferOfIntsL</a>()
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 _LIT(KCircularBufferForInt,<span class="stringliteral">"\n *****Circular buffer for integers*****"</span>);
<a name="l00111"></a>00111 iConsole->Printf(KCircularBufferForInt);
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="comment">// Creates a circular buffer containing integers.</span>
<a name="l00114"></a>00114 CCirBuffer* circularBuffer = <span class="keyword">new</span>(ELeave)CCirBuffer;
<a name="l00115"></a>00115 <span class="comment">// Push the circular buffer onto the cleanup stack.</span>
<a name="l00116"></a>00116 CleanupStack::PushL(circularBuffer);
<a name="l00117"></a>00117 <span class="keyword">const</span> TInt KMaxElements = 4;
<a name="l00118"></a>00118 <span class="comment">// Sets the maximum capacity of this circular buffer.</span>
<a name="l00119"></a>00119 circularBuffer->SetLengthL(KMaxElements); <span class="comment">// Maximum capacity is KMaxElements.</span>
<a name="l00120"></a>00120
<a name="l00121"></a>00121 iConsole->Printf(KConstruct);
<a name="l00122"></a>00122 _LIT(KConstructCircularBuffer, <span class="stringliteral">"\n Construction of circular buffer containing integers is successful"</span>);
<a name="l00123"></a>00123 iConsole->Printf(KConstructCircularBuffer);
<a name="l00124"></a>00124
<a name="l00125"></a>00125
<a name="l00126"></a>00126 iConsole->Printf(KAdd);
<a name="l00127"></a>00127 TUint element[6]= {1, 2, 3, 4, 5, 6};
<a name="l00128"></a>00128 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00129"></a>00129
<a name="l00130"></a>00130 _LIT(KAddedElements,<span class="stringliteral">"Added Element: %d\n"</span>);
<a name="l00131"></a>00131 TInt result=circularBuffer->Put(element[0]); <span class="comment">// Add integers to the circular buffer.</span>
<a name="l00132"></a>00132 User::LeaveIfError(result);
<a name="l00133"></a>00133 iConsole->Printf(KAddedElements,element[0]);
<a name="l00134"></a>00134 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="comment">// Add multiple integers to the circular buffer.</span>
<a name="l00137"></a>00137 TUint numberOfObjects= 3;
<a name="l00138"></a>00138 <span class="keywordflow">for</span>(TUint index=1;index<=numberOfObjects; index++)
<a name="l00139"></a>00139 {
<a name="l00140"></a>00140 result= circularBuffer->Put(element[index]);
<a name="l00141"></a>00141 User::LeaveIfError(result);
<a name="l00142"></a>00142 <span class="comment">// Print the element added to the circular buffer.</span>
<a name="l00143"></a>00143 iConsole->Printf(KAddedElements,element[index]);
<a name="l00144"></a>00144 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00145"></a>00145 }
<a name="l00146"></a>00146
<a name="l00147"></a>00147 _LIT(KAddIntegersToCircularBuffer,<span class="stringliteral">"\nAdding integers to circular buffer is successful"</span>);
<a name="l00148"></a>00148 iConsole->Printf(KAddIntegersToCircularBuffer);
<a name="l00149"></a>00149
<a name="l00150"></a>00150 iConsole->Printf(KPressAKey);
<a name="l00151"></a>00151 iConsole->Getch();
<a name="l00152"></a>00152
<a name="l00153"></a>00153 _LIT(KTryingAddToCircularBuffer,<span class="stringliteral">"\nTrying to add when buffer is full."</span>);
<a name="l00154"></a>00154 iConsole->Printf(KTryingAddToCircularBuffer);
<a name="l00155"></a>00155 result=circularBuffer->Put(element[4]);
<a name="l00156"></a>00156 ASSERT(result == KErrGeneral);
<a name="l00157"></a>00157 iConsole->Printf(KAddFailed);
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">// Remove integers from circular buffer.</span>
<a name="l00160"></a>00160 iConsole->Printf(KRemove);
<a name="l00161"></a>00161 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00162"></a>00162
<a name="l00163"></a>00163 result = circularBuffer->Get();
<a name="l00164"></a>00164 _LIT(KElementRemoved,<span class="stringliteral">"Removed Element: %d\n"</span>);
<a name="l00165"></a>00165 User::LeaveIfError(result);
<a name="l00166"></a>00166 ASSERT( (TUint) result == element[0]);
<a name="l00167"></a>00167 <span class="comment">// Print the element removed from the circular buffer.</span>
<a name="l00168"></a>00168 iConsole->Printf(KElementRemoved, result);
<a name="l00169"></a>00169 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00170"></a>00170
<a name="l00171"></a>00171
<a name="l00172"></a>00172 result = circularBuffer->Get();
<a name="l00173"></a>00173 User::LeaveIfError(result);
<a name="l00174"></a>00174 ASSERT((TUint)result == element[1]);
<a name="l00175"></a>00175 <span class="comment">// Print the element removed from the circular buffer.</span>
<a name="l00176"></a>00176 iConsole->Printf(KElementRemoved, result);
<a name="l00177"></a>00177 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="comment">//Add remaining elements from array to buffer.</span>
<a name="l00180"></a>00180 <span class="keywordflow">for</span>(TUint index=4;index<=5; index++)
<a name="l00181"></a>00181 {
<a name="l00182"></a>00182 result= circularBuffer->Put(element[index]);
<a name="l00183"></a>00183 User::LeaveIfError(result);
<a name="l00184"></a>00184 iConsole->Printf(KAddedElements,element[index]);
<a name="l00185"></a>00185 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00186"></a>00186 }
<a name="l00187"></a>00187 iConsole->Printf(KPressAKey);
<a name="l00188"></a>00188 iConsole->Getch();
<a name="l00189"></a>00189 _LIT(KNewLine,<span class="stringliteral">"\n"</span>);
<a name="l00190"></a>00190 iConsole->Printf(KNewLine);
<a name="l00191"></a>00191 <span class="comment">// Remove multiple integers from the circular buffer.</span>
<a name="l00192"></a>00192 <span class="keywordflow">for</span>(TUint index=2;index<=5; index++)
<a name="l00193"></a>00193 {
<a name="l00194"></a>00194 result= circularBuffer->Get();<span class="comment">// Removed integer is element[index].</span>
<a name="l00195"></a>00195 User::LeaveIfError(result);
<a name="l00196"></a>00196 ASSERT((TUint)result == element[index]);
<a name="l00197"></a>00197 <span class="comment">// Print the elements removed from the circular buffer.</span>
<a name="l00198"></a>00198 iConsole->Printf(KElementRemoved,result);
<a name="l00199"></a>00199 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201
<a name="l00202"></a>00202 _LIT(KRemoveIntegersFromCircularBuffer,<span class="stringliteral">"\nRemoving integers from the circular buffer is successful"</span>);
<a name="l00203"></a>00203 iConsole->Printf(KRemoveIntegersFromCircularBuffer);
<a name="l00204"></a>00204 iConsole->Printf(KPressAKey);
<a name="l00205"></a>00205 iConsole->Getch();
<a name="l00206"></a>00206
<a name="l00207"></a>00207 <span class="comment">//Pop the circular buffer off the cleanup stack and destroy it.</span>
<a name="l00208"></a>00208 CleanupStack::PopAndDestroy(circularBuffer);
<a name="l00209"></a>00209 }
<a name="l00210"></a>00210
<a name="l00215"></a><a class="code" href="class_c_circular_buffer_example.html#11ec0dc3b7d29955b891a8675bfeb555">00215</a> <span class="keywordtype">void</span> <a class="code" href="class_c_circular_buffer_example.html#11ec0dc3b7d29955b891a8675bfeb555">CCircularBufferExample::CircularBufferOfMyObjectsL</a>()
<a name="l00216"></a>00216 {
<a name="l00217"></a>00217 _LIT(KCircularBufferForMyObject,<span class="stringliteral">"\n *****Circular buffer of objects of user defined class TMyClass*****"</span>);
<a name="l00218"></a>00218 iConsole->Printf(KCircularBufferForMyObject);
<a name="l00219"></a>00219
<a name="l00220"></a>00220 <span class="comment">// Create a circular buffer containing instances of TMyClass.</span>
<a name="l00221"></a>00221 CCirBuf<TMyClass>* circularBuffer=<span class="keyword">new</span>(ELeave) CCirBuf<TMyClass>;
<a name="l00222"></a>00222 <span class="comment">// Push the circular buffer onto the cleanup stack.</span>
<a name="l00223"></a>00223 CleanupStack::PushL(circularBuffer);
<a name="l00224"></a>00224 <span class="comment">// Set the maximum capacity of this circular buffer.</span>
<a name="l00225"></a>00225 <span class="keyword">const</span> TInt KMaxElements = 4;
<a name="l00226"></a>00226 circularBuffer->SetLengthL(KMaxElements); <span class="comment">// Maximum capacity is KMaxElements.</span>
<a name="l00227"></a>00227 iConsole->Printf(KConstruct);
<a name="l00228"></a>00228
<a name="l00229"></a>00229 _LIT(KConstructCircularBufferForMyObject, <span class="stringliteral">"\n Construction of circular buffer of user defined class is successful\n"</span>);
<a name="l00230"></a>00230 iConsole->Printf(KConstructCircularBufferForMyObject);
<a name="l00231"></a>00231
<a name="l00232"></a>00232 iConsole->Printf(KAdd);
<a name="l00233"></a>00233 <span class="comment">// Creates an array of object of TMyClass. </span>
<a name="l00234"></a>00234 <a class="code" href="class_t_my_class.html">TMyClass</a> myObjectsToAdd[6];
<a name="l00235"></a>00235
<a name="l00236"></a>00236 _LIT(KBuffer1,<span class="stringliteral">"first"</span>);
<a name="l00237"></a>00237 myObjectsToAdd[0].<a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a>(KBuffer1);
<a name="l00238"></a>00238 _LIT(KBuffer2,<span class="stringliteral">"second"</span>);
<a name="l00239"></a>00239 myObjectsToAdd[1].<a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a>(KBuffer2);
<a name="l00240"></a>00240 _LIT(KBuffer3,<span class="stringliteral">"third"</span>);
<a name="l00241"></a>00241 myObjectsToAdd[2].<a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a>(KBuffer3);
<a name="l00242"></a>00242 _LIT(KBuffer4,<span class="stringliteral">"fourth"</span>);
<a name="l00243"></a>00243 myObjectsToAdd[3].<a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a>(KBuffer4);
<a name="l00244"></a>00244 _LIT(KBuffer5,<span class="stringliteral">"fifth"</span>);
<a name="l00245"></a>00245 myObjectsToAdd[4].<a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a>(KBuffer5);
<a name="l00246"></a>00246 _LIT(KBuffer6,<span class="stringliteral">"sixth"</span>);
<a name="l00247"></a>00247 myObjectsToAdd[5].<a class="code" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a>(KBuffer6);
<a name="l00248"></a>00248
<a name="l00249"></a>00249 _LIT(KAddedMyObjectElements,<span class="stringliteral">"\nTMyClass object added is: "</span>);
<a name="l00250"></a>00250 _LIT(KPrintMsgFormat,<span class="stringliteral">" \"%S\" "</span>);
<a name="l00251"></a>00251
<a name="l00252"></a>00252 TInt result= circularBuffer->Add(&myObjectsToAdd[0]); <span class="comment">// Add a TMyClass to the circular buffer.</span>
<a name="l00253"></a>00253 User::LeaveIfError(result);
<a name="l00254"></a>00254 ASSERT(result==1);
<a name="l00255"></a>00255 iConsole->Printf(KAddedMyObjectElements);
<a name="l00256"></a>00256 iConsole->Printf(KPrintMsgFormat,&(myObjectsToAdd[0].GetBuf()));
<a name="l00257"></a>00257 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00258"></a>00258
<a name="l00259"></a>00259
<a name="l00260"></a>00260 _LIT(KAddedMultipleMyObjectElements,<span class="stringliteral">"\nTMyClass objects added are : "</span>);
<a name="l00261"></a>00261 <span class="comment">// Add multiple TMyClasss to the circular buffer</span>
<a name="l00262"></a>00262 result= circularBuffer->Add(&myObjectsToAdd[1], 3); <span class="comment">// Add three objects to circular buffer.</span>
<a name="l00263"></a>00263 User::LeaveIfError(result);
<a name="l00264"></a>00264 ASSERT(result == 3); <span class="comment">//Making sure 3 objects are added.</span>
<a name="l00265"></a>00265 iConsole->Printf(KAddedMultipleMyObjectElements);
<a name="l00266"></a>00266 iConsole->Printf(KPrintMsgFormat,&(myObjectsToAdd[1].GetBuf()));
<a name="l00267"></a>00267 iConsole->Printf(KPrintMsgFormat,&(myObjectsToAdd[2].GetBuf()));
<a name="l00268"></a>00268 iConsole->Printf(KPrintMsgFormat,&(myObjectsToAdd[3].GetBuf()));
<a name="l00269"></a>00269 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00270"></a>00270
<a name="l00271"></a>00271 _LIT(KAddMyObjectsToCircularBuffer,<span class="stringliteral">"\nAdding objects of TMyClasss to circular buffer is successful"</span>);
<a name="l00272"></a>00272 iConsole->Printf(KAddMyObjectsToCircularBuffer);
<a name="l00273"></a>00273 iConsole->Printf(KPressAKey);
<a name="l00274"></a>00274 iConsole->Getch();
<a name="l00275"></a>00275
<a name="l00276"></a>00276
<a name="l00277"></a>00277 <span class="comment">//Array to hold removed elements from circular buffer.</span>
<a name="l00278"></a>00278 <a class="code" href="class_t_my_class.html">TMyClass</a> myRemovedObjects[6];
<a name="l00279"></a>00279 _LIT(KRemovedMultipleMyObjectElements,<span class="stringliteral">"\nTMyClass objects removed are: "</span>);
<a name="l00280"></a>00280
<a name="l00281"></a>00281 <span class="comment">// Remove multiple TMyClasss from the circular buffer.</span>
<a name="l00282"></a>00282 result= circularBuffer->Remove(&myRemovedObjects[0],2);
<a name="l00283"></a>00283 ASSERT(result == 2);
<a name="l00284"></a>00284 iConsole->Printf(KRemovedMultipleMyObjectElements);
<a name="l00285"></a>00285 iConsole->Printf(KPrintMsgFormat,&(myRemovedObjects[0].GetBuf()));
<a name="l00286"></a>00286 iConsole->Printf(KPrintMsgFormat,&(myRemovedObjects[1].GetBuf()));
<a name="l00287"></a>00287 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00288"></a>00288
<a name="l00289"></a>00289 <span class="comment">// Add two elements to circular buffer</span>
<a name="l00290"></a>00290 result= circularBuffer->Add(&myObjectsToAdd[4],2);
<a name="l00291"></a>00291 User::LeaveIfError(result);
<a name="l00292"></a>00292 ASSERT(result == 2);
<a name="l00293"></a>00293 iConsole->Printf(KAddedMultipleMyObjectElements);
<a name="l00294"></a>00294 iConsole->Printf(KPrintMsgFormat,&(myObjectsToAdd[4].GetBuf()));
<a name="l00295"></a>00295 iConsole->Printf(KPrintMsgFormat,&(myObjectsToAdd[5].GetBuf()));
<a name="l00296"></a>00296 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="comment">// Remove multiple TMyClasss from the circular buffer.</span>
<a name="l00299"></a>00299 result= circularBuffer->Remove(&myRemovedObjects[2],4);
<a name="l00300"></a>00300 ASSERT(result == 4);
<a name="l00301"></a>00301 iConsole->Printf(KRemovedMultipleMyObjectElements);
<a name="l00302"></a>00302 iConsole->Printf(KPrintMsgFormat,&(myRemovedObjects[2].GetBuf()));
<a name="l00303"></a>00303 iConsole->Printf(KPrintMsgFormat,&(myRemovedObjects[3].GetBuf()));
<a name="l00304"></a>00304 iConsole->Printf(KPrintMsgFormat,&(myRemovedObjects[4].GetBuf()));
<a name="l00305"></a>00305 iConsole->Printf(KPrintMsgFormat,&(myRemovedObjects[5].GetBuf()));
<a name="l00306"></a>00306 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <span class="keywordflow">for</span>(TInt index=0;index<6;index++)
<a name="l00309"></a>00309 {
<a name="l00310"></a>00310 <span class="comment">// The removed objects are same as added ones and are in order.</span>
<a name="l00311"></a>00311 ASSERT(myRemovedObjects[index].GetBuf() == myObjectsToAdd[index].GetBuf());
<a name="l00312"></a>00312 }
<a name="l00313"></a>00313
<a name="l00314"></a>00314 _LIT(KRemoveMyObjectsFromCircularBuffer,<span class="stringliteral">"\nRemoving TMyClass objects from circular buffer is successful"</span>);
<a name="l00315"></a>00315 iConsole->Printf(KRemoveMyObjectsFromCircularBuffer);
<a name="l00316"></a>00316 iConsole->Printf(KPressAKey);
<a name="l00317"></a>00317 iConsole->Getch();
<a name="l00318"></a>00318
<a name="l00319"></a>00319 <span class="comment">//Pop the circular buffer off the cleanup stack and destroy it.</span>
<a name="l00320"></a>00320 CleanupStack::PopAndDestroy(circularBuffer);
<a name="l00321"></a>00321 }
<a name="l00322"></a>00322
<a name="l00326"></a><a class="code" href="class_c_circular_buffer_example.html#c317019ee3a32d5dcef6a90e5a52913c">00326</a> <span class="keywordtype">void</span> <a class="code" href="class_c_circular_buffer_example.html#c317019ee3a32d5dcef6a90e5a52913c">CCircularBufferExample::CircularBufferOfRClasssL</a>()
<a name="l00327"></a>00327 {
<a name="l00328"></a>00328 _LIT(KCircularBufferForRBuf,<span class="stringliteral">"\n *****Circular buffer of R Class*****"</span>);
<a name="l00329"></a>00329 iConsole->Printf(KCircularBufferForRBuf);
<a name="l00330"></a>00330 <span class="comment">// Creates a circular buffer containing RBuf.</span>
<a name="l00331"></a>00331 CCirBuf<RBuf>* circularBuffer=<span class="keyword">new</span>(ELeave)CCirBuf<RBuf>;
<a name="l00332"></a>00332 <span class="comment">// Push the circular buffer onto the cleanup stack.</span>
<a name="l00333"></a>00333 CleanupStack::PushL(circularBuffer);
<a name="l00334"></a>00334
<a name="l00335"></a>00335 <span class="keyword">const</span> TInt KMaxElements = 2;
<a name="l00336"></a>00336 <span class="comment">// Sets the maximum capacity of this circular buffer.</span>
<a name="l00337"></a>00337 circularBuffer->SetLengthL(KMaxElements);<span class="comment">// max capacity is KMaxElements</span>
<a name="l00338"></a>00338 iConsole->Printf(KConstruct);
<a name="l00339"></a>00339 _LIT(KConstructCircularBufferForRBuf, <span class="stringliteral">"\n Construction of circular buffer of R Class is successful"</span>);
<a name="l00340"></a>00340 iConsole->Printf(KConstructCircularBufferForRBuf);
<a name="l00341"></a>00341
<a name="l00342"></a>00342 RBuf bufToAdd1;
<a name="l00343"></a>00343 _LIT(KBuffer1,<span class="stringliteral">"11111"</span>);
<a name="l00344"></a>00344 <span class="comment">// Create an buffer descriptor and assign KBuffer1 data to the descriptor.</span>
<a name="l00345"></a>00345 bufToAdd1.CreateL(KBuffer1);
<a name="l00346"></a>00346
<a name="l00347"></a>00347 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00348"></a>00348
<a name="l00349"></a>00349 _LIT(KAddedElements,<span class="stringliteral">"Added Element: "</span>);
<a name="l00350"></a>00350 iConsole->Printf(KAdd);
<a name="l00351"></a>00351 TInt result=circularBuffer->Add(&bufToAdd1); <span class="comment">// Add a Rbuf object to the circular buffer.</span>
<a name="l00352"></a>00352 User::LeaveIfError(result);
<a name="l00353"></a>00353 ASSERT(result == 1);
<a name="l00354"></a>00354 iConsole->Printf(KAddedElements);
<a name="l00355"></a>00355 iConsole->Printf(bufToAdd1);
<a name="l00356"></a>00356 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00357"></a>00357
<a name="l00358"></a>00358 _LIT(KBuffer2,<span class="stringliteral">"22222"</span>);
<a name="l00359"></a>00359 RBuf bufToAdd2;
<a name="l00360"></a>00360 <span class="comment">// Create an buffer descriptor and assign KBuffer2 data to the descriptor.</span>
<a name="l00361"></a>00361 bufToAdd2.CreateL(KBuffer2);
<a name="l00362"></a>00362
<a name="l00363"></a>00363 result=circularBuffer->Add(&bufToAdd2); <span class="comment">// Add a Rbuf object to the circular buffer.</span>
<a name="l00364"></a>00364 User::LeaveIfError(result);
<a name="l00365"></a>00365 ASSERT(result == 1);
<a name="l00366"></a>00366 iConsole->Printf(KAddedElements);
<a name="l00367"></a>00367 iConsole->Printf(bufToAdd2);
<a name="l00368"></a>00368 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00369"></a>00369
<a name="l00370"></a>00370 _LIT(KAddRBufferToCircularBuffer,<span class="stringliteral">"\nAdding to circular buffer of R Class is successful\n"</span>);
<a name="l00371"></a>00371 iConsole->Printf(KAddRBufferToCircularBuffer);
<a name="l00372"></a>00372
<a name="l00373"></a>00373 RBuf bufToRemove;
<a name="l00374"></a>00374 iConsole->Printf(KRemove);
<a name="l00375"></a>00375 _LIT(KElementRemoved,<span class="stringliteral">"Removed Element: "</span>);
<a name="l00376"></a>00376
<a name="l00377"></a>00377 result=circularBuffer->Remove(&bufToRemove); <span class="comment">//bufToRemove will point to bufToAdd1 location.</span>
<a name="l00378"></a>00378 ASSERT(result == 1);
<a name="l00379"></a>00379 iConsole->Printf(KElementRemoved);
<a name="l00380"></a>00380 iConsole->Printf(bufToRemove);
<a name="l00381"></a>00381 iConsole->Printf(KNumberOfObjects, circularBuffer->Count());
<a name="l00382"></a>00382
<a name="l00383"></a>00383
<a name="l00384"></a>00384 bufToAdd2.Close();
<a name="l00385"></a>00385 bufToRemove.Close();
<a name="l00386"></a>00386 CleanupStack::PopAndDestroy(circularBuffer);
<a name="l00387"></a>00387 _LIT(KPressAnyKeyToExit,<span class="stringliteral">"\nPress any key to exit "</span>);
<a name="l00388"></a>00388 iConsole->Printf(KPressAnyKeyToExit);
<a name="l00389"></a>00389 iConsole->Getch();
<a name="l00390"></a>00390 }
<a name="l00391"></a>00391
<a name="l00392"></a>00392
<a name="l00393"></a><a class="code" href="circularbuffer_8cpp.html#5fb473d4ee18739183215b04dcad6e12">00393</a> <span class="keywordtype">void</span> <a class="code" href="circularbuffer_8cpp.html#5fb473d4ee18739183215b04dcad6e12">MainL</a>()
<a name="l00394"></a>00394 {
<a name="l00395"></a>00395 <a class="code" href="class_c_circular_buffer_example.html">CCircularBufferExample</a>* app= <a class="code" href="class_c_circular_buffer_example.html#db5aee8a165729ff3c4a87fb5fc69426">CCircularBufferExample::NewL</a>();
<a name="l00396"></a>00396 CleanupStack::PushL(app);
<a name="l00397"></a>00397
<a name="l00398"></a>00398 <span class="comment">// Circular buffer containing integers.</span>
<a name="l00399"></a>00399 app-><a class="code" href="class_c_circular_buffer_example.html#a197a8d4f8585a4277c286e02dc1d1ce">CircularBufferOfIntsL</a>();
<a name="l00400"></a>00400
<a name="l00401"></a>00401 <span class="comment">// Circular buffer containing TMyClasss.</span>
<a name="l00402"></a>00402 app-><a class="code" href="class_c_circular_buffer_example.html#11ec0dc3b7d29955b891a8675bfeb555">CircularBufferOfMyObjectsL</a>();
<a name="l00403"></a>00403
<a name="l00404"></a>00404 <span class="comment">// Circular buffer containing RBuf </span>
<a name="l00405"></a>00405 app-><a class="code" href="class_c_circular_buffer_example.html#c317019ee3a32d5dcef6a90e5a52913c">CircularBufferOfRClasssL</a>();
<a name="l00406"></a>00406 CleanupStack::PopAndDestroy(app);
<a name="l00407"></a>00407 }
<a name="l00408"></a>00408
<a name="l00409"></a><a class="code" href="circularbuffer_8cpp.html#0f358e9c4355138f629b8c4f37310295">00409</a> GLDEF_C TInt <a class="code" href="dbllist_8cpp.html#0f358e9c4355138f629b8c4f37310295">E32Main</a>()
<a name="l00410"></a>00410 {
<a name="l00411"></a>00411 __UHEAP_MARK;
<a name="l00412"></a>00412
<a name="l00413"></a>00413 CTrapCleanup* cleanup = CTrapCleanup::New();
<a name="l00414"></a>00414 <span class="keywordflow">if</span>(cleanup == NULL)
<a name="l00415"></a>00415 {
<a name="l00416"></a>00416 <span class="keywordflow">return</span> KErrNoMemory;
<a name="l00417"></a>00417 }
<a name="l00418"></a>00418 TRAPD(err, <a class="code" href="circularbuffer_8cpp.html#5fb473d4ee18739183215b04dcad6e12">MainL</a>());
<a name="l00419"></a>00419 <span class="keywordflow">if</span>(err !=KErrNone)
<a name="l00420"></a>00420 {
<a name="l00421"></a>00421 _LIT(KFailed, <span class="stringliteral">"\nFailed to complete"</span>);
<a name="l00422"></a>00422 User::Panic(KFailed, err);
<a name="l00423"></a>00423 }
<a name="l00424"></a>00424 <span class="keyword">delete</span> cleanup;
<a name="l00425"></a>00425
<a name="l00426"></a>00426 __UHEAP_MARKEND;
<a name="l00427"></a>00427 <span class="keywordflow">return</span> KErrNone;
<a name="l00428"></a>00428 }
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:32:55 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>