Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_t_and_r_classes_8cpp_source.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: examples/Basics/TAndRClasses/TAndRClasses.cpp Source File</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 -->
<h1>examples/Basics/TAndRClasses/TAndRClasses.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2000-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">// TAndRClass.cpp</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#include "CommonFramework.h"</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtTIntHolderDestructor,<span class="stringliteral">"TIntHolder destructor\n"</span>);
<a name="l00020"></a>00020 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KCommonFormat1,<span class="stringliteral">"Int()=%d\n"</span>);
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// T class</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">class </span>TIntHolder
<a name="l00025"></a>00025 {
<a name="l00026"></a>00026 <span class="keyword">public</span>: <span class="comment">// data</span>
<a name="l00027"></a>00027 TInt iInt;
<a name="l00028"></a>00028 <span class="keyword">public</span>: <span class="comment">// functions</span>
<a name="l00029"></a>00029 TInt Int() { <span class="keywordflow">return</span> iInt; }; <span class="comment">// get the integer</span>
<a name="l00030"></a>00030 <span class="keywordtype">void</span> SetInt(TInt aInt) { iInt=aInt; }; <span class="comment">// set the integer</span>
<a name="l00031"></a>00031 <span class="keywordtype">void</span> Double() { iInt *= 2; }; <span class="comment">// double the integer</span>
<a name="l00032"></a>00032 TBool IsNonZero() { <span class="keywordflow">return</span> iInt!=0; }; <span class="comment">// check whether zero</span>
<a name="l00033"></a>00033 <span class="comment">// destructor, coded only to show when taken and when not</span>
<a name="l00034"></a>00034 ~TIntHolder() { console->Printf(KTxtTIntHolderDestructor); };
<a name="l00035"></a>00035 };
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keywordtype">void</span> demonstrateTTypeL(); <span class="comment">// function to demonstrate T type</span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">// class RTimer - a typical R class</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">// an R class with added clean-up support</span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">class </span>RTimerWithCleanup : <span class="keyword">public</span> RTimer
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">public</span>: <span class="comment">// no extra data, just inherit everything from base</span>
<a name="l00046"></a>00046 <span class="keyword">public</span>: <span class="comment">// functions</span>
<a name="l00047"></a>00047 <span class="comment">// required for clean-up support</span>
<a name="l00048"></a>00048 operator TCleanupItem()
<a name="l00049"></a>00049 { <span class="comment">// convert to clean-up item</span>
<a name="l00050"></a>00050 <span class="keywordflow">return</span> TCleanupItem(Cleanup,<span class="keyword">this</span>);
<a name="l00051"></a>00051 <span class="comment">// clean-up = function + object</span>
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053 <span class="keyword">static</span> <span class="keywordtype">void</span> Cleanup(TAny *aPtr)
<a name="l00054"></a>00054 { <span class="comment">// static clean-up function returned by TCleanupItem</span>
<a name="l00055"></a>00055 ((RTimerWithCleanup*)aPtr) -> DoCleanup();
<a name="l00056"></a>00056 <span class="comment">// do clean-up neatly, using regular member function</span>
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058 <span class="keywordtype">void</span> DoCleanup()
<a name="l00059"></a>00059 { <span class="comment">// do clean-up neatly</span>
<a name="l00060"></a>00060 Close(); <span class="comment">// close timer</span>
<a name="l00061"></a>00061 }
<a name="l00062"></a>00062 <span class="comment">// helpful for automatically putting onto clean-up stack</span>
<a name="l00063"></a>00063 <span class="keywordtype">void</span> CreateLocalLC()
<a name="l00064"></a>00064 { <span class="comment">// call RTImer::CreateLocal(), and push to clean-up stack</span>
<a name="l00065"></a>00065 User::LeaveIfError(CreateLocal()); <span class="comment">// create, but leave if couldn't</span>
<a name="l00066"></a>00066 CleanupStack::PushL(*<span class="keyword">this</span>); <span class="comment">// push to clean-up stack</span>
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068 <span class="comment">// debug version of RTimer::Close()</span>
<a name="l00069"></a>00069 <span class="keywordtype">void</span> Close()
<a name="l00070"></a>00070 { <span class="comment">// debug version of close</span>
<a name="l00071"></a>00071 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtClosingRTimer,<span class="stringliteral">"Closing RTimerWithCleanup\n"</span>);
<a name="l00072"></a>00072 console->Printf(KTxtClosingRTimer);
<a name="l00073"></a>00073 RTimer::Close(); <span class="comment">// base call</span>
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keywordtype">void</span> demonstrateRTypeL(); <span class="comment">// function to demonstrate R type</span>
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// Do the example</span>
<a name="l00080"></a>00080 LOCAL_C <span class="keywordtype">void</span> doExampleL()
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 demonstrateTTypeL(); <span class="comment">// demonstrate T type</span>
<a name="l00083"></a>00083 demonstrateRTypeL(); <span class="comment">// demonstrate R type</span>
<a name="l00084"></a>00084 }
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">// stuff to demonstrate T type</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keywordtype">void</span> useTTypeL(TIntHolder aIntHolder); <span class="comment">// function using a T</span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keywordtype">void</span> demonstrateTTypeL()
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtStartingDemoTTypeL,<span class="stringliteral">"Starting demonstrateTTypeL()\n"</span>);
<a name="l00093"></a>00093 console->Printf(KTxtStartingDemoTTypeL);
<a name="l00094"></a>00094 TIntHolder t; <span class="comment">// declare variable</span>
<a name="l00095"></a>00095 <span class="comment">// do a few things with it</span>
<a name="l00096"></a>00096 t.SetInt(3);
<a name="l00097"></a>00097 t.Double();
<a name="l00098"></a>00098 TInt i=t.Int();
<a name="l00099"></a>00099 console->Printf(KCommonFormat1, i);
<a name="l00100"></a>00100 <span class="comment">// optionally leave</span>
<a name="l00101"></a>00101 <span class="comment">//</span>
<a name="l00102"></a>00102 <span class="comment">// Remove comments on next line to show this</span>
<a name="l00103"></a>00103 <span class="comment">//User::Leave(KErrGeneral);</span>
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="comment">// now use T type</span>
<a name="l00106"></a>00106 useTTypeL(t); <span class="comment">// pass by value</span>
<a name="l00107"></a>00107 <span class="comment">// end demo: T will be destructed (for what it's worth)</span>
<a name="l00108"></a>00108 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtFinishingDemoTTypeL,<span class="stringliteral">"Finishing demonstrateTTypeL()\n"</span>);
<a name="l00109"></a>00109 console->Printf(KTxtFinishingDemoTTypeL);
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keywordtype">void</span> useTTypeL(TIntHolder aIntHolder)
<a name="l00113"></a>00113 { <span class="comment">// function using a T</span>
<a name="l00114"></a>00114 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtStartinguseTTypeL,<span class="stringliteral">"Starting useTTypeL()\n"</span>);
<a name="l00115"></a>00115 console->Printf(KTxtStartinguseTTypeL);
<a name="l00116"></a>00116 aIntHolder.Double(); <span class="comment">// double the value</span>
<a name="l00117"></a>00117 TInt i=aIntHolder.Int(); <span class="comment">// get value</span>
<a name="l00118"></a>00118 console->Printf(KCommonFormat1, i);
<a name="l00119"></a>00119 <span class="comment">// optionally leave</span>
<a name="l00120"></a>00120 <span class="comment">//</span>
<a name="l00121"></a>00121 <span class="comment">// Remove comments on next line to show this</span>
<a name="l00122"></a>00122 <span class="comment">//User::Leave(KErrGeneral);</span>
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="comment">// now finished</span>
<a name="l00125"></a>00125 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtFinishinguseTTypeL,<span class="stringliteral">"Finishing useTTypeL()\n"</span>);
<a name="l00126"></a>00126 console->Printf(KTxtFinishinguseTTypeL);
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">// stuff to demonstrate R type</span>
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keywordtype">void</span> useRTypeL(RTimerWithCleanup aTimer);
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keywordtype">void</span> demonstrateRTypeL()
<a name="l00134"></a>00134 {
<a name="l00135"></a>00135 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtStartDemoRTypeL,<span class="stringliteral">"Starting demonstrateRTypeL()\n"</span>);
<a name="l00136"></a>00136 console->Printf(KTxtStartDemoRTypeL);
<a name="l00137"></a>00137 <span class="comment">// declare R type on the stack, and push to clean-up stack</span>
<a name="l00138"></a>00138 RTimerWithCleanup timer; <span class="comment">// declare on stack</span>
<a name="l00139"></a>00139 timer.CreateLocalLC(); <span class="comment">// initialize, push to clean-up stack</span>
<a name="l00140"></a>00140 <span class="comment">// use the R type</span>
<a name="l00141"></a>00141 TRequestStatus status; <span class="comment">// needed for asynchronous service</span>
<a name="l00142"></a>00142 timer.After(status,1000000); <span class="comment">// request completion in 1,000,000 micro seconds</span>
<a name="l00143"></a>00143 User::WaitForRequest(status); <span class="comment">// wait for completion</span>
<a name="l00144"></a>00144 <span class="comment">// optionally leave</span>
<a name="l00145"></a>00145 <span class="comment">//</span>
<a name="l00146"></a>00146 <span class="comment">// Remove comments on next line to show this</span>
<a name="l00147"></a>00147 <span class="comment">//User::Leave(KErrGeneral);</span>
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="comment">// pass to another function</span>
<a name="l00150"></a>00150 useRTypeL(timer); <span class="comment">// use in another function</span>
<a name="l00151"></a>00151 <span class="comment">// now finished</span>
<a name="l00152"></a>00152 CleanupStack::PopAndDestroy(); <span class="comment">// pop and destroy timer</span>
<a name="l00153"></a>00153 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtFinishDemoRTypeL,<span class="stringliteral">"Finishing demonstrateRTypeL()\n"</span>);
<a name="l00154"></a>00154 console->Printf(KTxtFinishDemoRTypeL);
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="keywordtype">void</span> useRTypeL(RTimerWithCleanup aTimer)
<a name="l00158"></a>00158 { <span class="comment">// use an R type</span>
<a name="l00159"></a>00159 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtStartuseRTypeL,<span class="stringliteral">"Starting useRTypeL()\n"</span>);
<a name="l00160"></a>00160 console->Printf(KTxtStartuseRTypeL);
<a name="l00161"></a>00161 <span class="comment">// use the R type</span>
<a name="l00162"></a>00162 TRequestStatus status; <span class="comment">// needed for asynchronous service</span>
<a name="l00163"></a>00163 aTimer.After(status,1000000); <span class="comment">// request completion in 1000000 micro seconds</span>
<a name="l00164"></a>00164 User::WaitForRequest(status); <span class="comment">// wait for completion</span>
<a name="l00165"></a>00165 <span class="comment">// optionally leave</span>
<a name="l00166"></a>00166 <span class="comment">//</span>
<a name="l00167"></a>00167 <span class="comment">// Remove comments on next line to show this</span>
<a name="l00168"></a>00168 <span class="comment">//User::Leave(KErrGeneral);</span>
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="comment">// now finished</span>
<a name="l00171"></a>00171 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtFinishuseRTypeL,<span class="stringliteral">"Finishing useRTypeL()\n"</span>);
<a name="l00172"></a>00172 console->Printf(KTxtFinishuseRTypeL);
<a name="l00173"></a>00173 }
</pre></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>