Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_c_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/CClasses/CClasses.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/CClasses/CClasses.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">//</span>
<a name="l00015"></a>00015
<a name="l00016"></a>00016 <span class="preprocessor">#include "CommonFramework.h"</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">// start of real example</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="comment">// #include specific files</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// class with single-phase construction, NewL and NewLC</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">class </span>COnePhaser : <span class="keyword">public</span> CBase {
<a name="l00025"></a>00025 <span class="keyword">public</span>: <span class="comment">// data</span>
<a name="l00026"></a>00026 TInt iInt1; <span class="comment">// one integer</span>
<a name="l00027"></a>00027 TInt iInt2; <span class="comment">// another integer</span>
<a name="l00028"></a>00028 <span class="keyword">public</span>: <span class="comment">// functions</span>
<a name="l00029"></a>00029 <span class="comment">// construct/destruct</span>
<a name="l00030"></a>00030 <span class="keyword">static</span> COnePhaser* NewL()
<a name="l00031"></a>00031 { <span class="comment">// construct and leave if error</span>
<a name="l00032"></a>00032 <span class="keywordflow">return</span> <span class="keyword">new</span> (ELeave) COnePhaser; <span class="comment">// new COnePhaser, C++ constructor</span>
<a name="l00033"></a>00033 };
<a name="l00034"></a>00034 <span class="keyword">static</span> COnePhaser* NewLC()
<a name="l00035"></a>00035 { <span class="comment">// construct, leave if error, else push to clean-up stack</span>
<a name="l00036"></a>00036 COnePhaser* <span class="keyword">self</span>=COnePhaser::NewL(); <span class="comment">// construct</span>
<a name="l00037"></a>00037 CleanupStack::PushL(<span class="keyword">self</span>); <span class="comment">// push to clean-up stack</span>
<a name="l00038"></a>00038 <span class="keywordflow">return</span> <span class="keyword">self</span>; <span class="comment">// and return new object</span>
<a name="l00039"></a>00039 };
<a name="l00040"></a>00040 <span class="comment">// other functions</span>
<a name="l00041"></a>00041 <span class="keywordtype">void</span> Print()
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KFormat1,<span class="stringliteral">"COnePhaser {TInt %d, TInt %d}"</span>);
<a name="l00044"></a>00044 console->Printf(KFormat1, iInt1, iInt2);
<a name="l00045"></a>00045 }
<a name="l00046"></a>00046 <span class="keyword">protected</span>: <span class="comment">// functions</span>
<a name="l00047"></a>00047 <span class="comment">// construct</span>
<a name="l00048"></a>00048 COnePhaser()
<a name="l00049"></a>00049 { <span class="comment">// standard C++ constructor, because it cannot leave</span>
<a name="l00050"></a>00050 iInt1=3; <span class="comment">// set first int to 3</span>
<a name="l00051"></a>00051 <span class="comment">// iInt2=0; // unnecessary</span>
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053 };
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">// class with two-phase construction</span>
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">class </span>CTwoPhaser : <span class="keyword">public</span> CBase {
<a name="l00058"></a>00058 <span class="keyword">public</span>: <span class="comment">// data</span>
<a name="l00059"></a>00059 TInt iInt1; <span class="comment">// one integer</span>
<a name="l00060"></a>00060 TInt iInt2; <span class="comment">// another integer</span>
<a name="l00061"></a>00061 RTimer iTimer; <span class="comment">// a resource</span>
<a name="l00062"></a>00062 COnePhaser* iOnePhaser; <span class="comment">// another CBase object</span>
<a name="l00063"></a>00063 <span class="keyword">public</span>: <span class="comment">// functions</span>
<a name="l00064"></a>00064 <span class="comment">// construct/destruct</span>
<a name="l00065"></a>00065 <span class="keyword">static</span> CTwoPhaser* NewLC(TInt aInt1)
<a name="l00066"></a>00066 { <span class="comment">// construct and leave on the clean-up stack</span>
<a name="l00067"></a>00067 CTwoPhaser* <span class="keyword">self</span>=<span class="keyword">new</span> (ELeave) CTwoPhaser; <span class="comment">// new CTwoPhaser, initialized to binary zeroes</span>
<a name="l00068"></a>00068 CleanupStack::PushL(<span class="keyword">self</span>); <span class="comment">// push to clean-up stack</span>
<a name="l00069"></a>00069 <span class="keyword">self</span>->ConstructL(aInt1); <span class="comment">// construct</span>
<a name="l00070"></a>00070 <span class="keywordflow">return</span> <span class="keyword">self</span>; <span class="comment">// return new object</span>
<a name="l00071"></a>00071 };
<a name="l00072"></a>00072 <span class="keyword">static</span> CTwoPhaser* NewL(TInt aInt1)
<a name="l00073"></a>00073 { <span class="comment">// construct and don't leave on clean-up stack</span>
<a name="l00074"></a>00074 CTwoPhaser* <span class="keyword">self</span>=CTwoPhaser::NewLC(aInt1); <span class="comment">// construct and leave on clean-up stack</span>
<a name="l00075"></a>00075 CleanupStack::Pop(); <span class="comment">// pop from clean-up stack</span>
<a name="l00076"></a>00076 <span class="keywordflow">return</span> <span class="keyword">self</span>; <span class="comment">// return new object</span>
<a name="l00077"></a>00077 };
<a name="l00078"></a>00078 <span class="keyword">virtual</span> ~CTwoPhaser()
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080 <span class="keyword">delete</span> iOnePhaser; <span class="comment">// just destroy anything we point to</span>
<a name="l00081"></a>00081 iTimer.Close(); <span class="comment">// close timer</span>
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083 <span class="comment">// other functions</span>
<a name="l00084"></a>00084 <span class="keywordtype">void</span> Print()
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KFormat2,<span class="stringliteral">"CTwoPhaser {TInt %d, TInt %d, RTimer, "</span>);
<a name="l00087"></a>00087 console->Printf(KFormat2, iInt1, iInt2);
<a name="l00088"></a>00088 iOnePhaser->Print();
<a name="l00089"></a>00089 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KtxtCloseCurly,<span class="stringliteral">"}"</span>);
<a name="l00090"></a>00090 console->Printf(KtxtCloseCurly);
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092 <span class="keyword">protected</span>: <span class="comment">// functions</span>
<a name="l00093"></a>00093 <span class="comment">// construct support</span>
<a name="l00094"></a>00094 <span class="keywordtype">void</span> ConstructL(TInt aInt1)
<a name="l00095"></a>00095 { <span class="comment">// do the work involved in construction</span>
<a name="l00096"></a>00096 iInt1=aInt1; <span class="comment">// assign iInt1 from argument</span>
<a name="l00097"></a>00097 User::LeaveIfError(iTimer.CreateLocal()); <span class="comment">// initialize timer</span>
<a name="l00098"></a>00098 iOnePhaser=COnePhaser::NewL(); <span class="comment">// make a new one-phaser</span>
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100 };
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="comment">// abstract class derived from CBase</span>
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keyword">class </span>CAbstract : <span class="keyword">public</span> CBase
<a name="l00105"></a>00105 {
<a name="l00106"></a>00106 <span class="keyword">public</span>: <span class="comment">// data</span>
<a name="l00107"></a>00107 CTwoPhaser* iTwoPhaser; <span class="comment">// a contained object</span>
<a name="l00108"></a>00108 <span class="keyword">public</span>: <span class="comment">// functions</span>
<a name="l00109"></a>00109 <span class="keywordtype">void</span> SomeFunction(TInt aInt)
<a name="l00110"></a>00110 { <span class="comment">// request some function</span>
<a name="l00111"></a>00111 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtbeginSomeFunction,<span class="stringliteral">"beginning to do SomeFunction()\n"</span>);
<a name="l00112"></a>00112 console->Printf(KTxtbeginSomeFunction);
<a name="l00113"></a>00113 DoSomeFunction(aInt); <span class="comment">// invoke virtual function</span>
<a name="l00114"></a>00114 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtfinishSomeFunction,<span class="stringliteral">"finished doing SomeFunction()\n"</span>);
<a name="l00115"></a>00115 console->Printf(KTxtfinishSomeFunction);
<a name="l00116"></a>00116 }
<a name="l00117"></a>00117 <span class="keyword">virtual</span> ~CAbstract()
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="keyword">delete</span> iTwoPhaser;
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121 <span class="keyword">protected</span>:
<a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoSomeFunction(TInt aInt) <span class="keyword">const</span> =0;
<a name="l00123"></a>00123 <span class="comment">// implement heart of some function, in derived class</span>
<a name="l00124"></a>00124 <span class="keywordtype">void</span> ConstructL(TInt aInt)
<a name="l00125"></a>00125 { <span class="comment">// second phase of constructor</span>
<a name="l00126"></a>00126 iTwoPhaser=CTwoPhaser::NewL(aInt);
<a name="l00127"></a>00127 <span class="comment">// construct embedded object</span>
<a name="l00128"></a>00128 }
<a name="l00129"></a>00129 };
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">// class derived from above</span>
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keyword">class </span>CConcrete : <span class="keyword">public</span> CAbstract
<a name="l00134"></a>00134 {
<a name="l00135"></a>00135 <span class="keyword">public</span>: <span class="comment">// data</span>
<a name="l00136"></a>00136 COnePhaser* iOnePhaser; <span class="comment">// some extra data</span>
<a name="l00137"></a>00137 <span class="keyword">public</span>: <span class="comment">// functions</span>
<a name="l00138"></a>00138 <span class="comment">// construct/destruct</span>
<a name="l00139"></a>00139 <span class="keyword">static</span> CConcrete* NewLC(TInt aInt)
<a name="l00140"></a>00140 { <span class="comment">// construct and leave on the clean-up stack</span>
<a name="l00141"></a>00141 CConcrete* <span class="keyword">self</span>=<span class="keyword">new</span> (ELeave) CConcrete; <span class="comment">// new object, C++ constructor</span>
<a name="l00142"></a>00142 CleanupStack::PushL(<span class="keyword">self</span>); <span class="comment">// push to clean-up stack</span>
<a name="l00143"></a>00143 <span class="keyword">self</span>->ConstructL(aInt); <span class="comment">// CBase constructor</span>
<a name="l00144"></a>00144 <span class="keywordflow">return</span> <span class="keyword">self</span>; <span class="comment">// return new object</span>
<a name="l00145"></a>00145 };
<a name="l00146"></a>00146 <span class="keyword">static</span> CConcrete* NewL(TInt aInt)
<a name="l00147"></a>00147 { <span class="comment">// construct and don't leave on clean-up stack</span>
<a name="l00148"></a>00148 CConcrete* <span class="keyword">self</span>=CConcrete::NewLC(aInt); <span class="comment">// construct and leave on clean-up stack</span>
<a name="l00149"></a>00149 CleanupStack::Pop(); <span class="comment">// pop from clean-up stack</span>
<a name="l00150"></a>00150 <span class="keywordflow">return</span> <span class="keyword">self</span>; <span class="comment">// return new object</span>
<a name="l00151"></a>00151 };
<a name="l00152"></a>00152 <span class="keyword">virtual</span> ~CConcrete()
<a name="l00153"></a>00153 {
<a name="l00154"></a>00154 <span class="keyword">delete</span> iOnePhaser; <span class="comment">// destroy member</span>
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 <span class="comment">// protocol</span>
<a name="l00157"></a>00157 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoSomeFunction(TInt aInt)<span class="keyword"> const</span>
<a name="l00158"></a>00158 <span class="keyword"> </span>{ <span class="comment">// implementation of base class's pure-virtual function</span>
<a name="l00159"></a>00159 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KFormat3,<span class="stringliteral">"CConcrete::DoSomething(%d)\n"</span>);
<a name="l00160"></a>00160 console->Printf(KFormat3, aInt);
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162 <span class="keyword">protected</span>:
<a name="l00163"></a>00163 <span class="comment">// construct/destruct</span>
<a name="l00164"></a>00164 <span class="keywordtype">void</span> ConstructL(TInt aInt)
<a name="l00165"></a>00165 { <span class="comment">// second phase of construction</span>
<a name="l00166"></a>00166 CAbstract::ConstructL(aInt); <span class="comment">// base class constructor</span>
<a name="l00167"></a>00167 iOnePhaser=COnePhaser::NewL(); <span class="comment">// contained member constructor</span>
<a name="l00168"></a>00168 }
<a name="l00169"></a>00169 };
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="comment">// do the example</span>
<a name="l00172"></a>00172 LOCAL_C <span class="keywordtype">void</span> doExampleL()
<a name="l00173"></a>00173 {
<a name="l00174"></a>00174 <span class="comment">// two-phase object</span>
<a name="l00175"></a>00175 CTwoPhaser* twoPhaser=CTwoPhaser::NewLC(5);
<a name="l00176"></a>00176 <span class="comment">// new two-phase object</span>
<a name="l00177"></a>00177 twoPhaser->Print(); <span class="comment">// print it</span>
<a name="l00178"></a>00178 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KTxtNewLine,<span class="stringliteral">"\n"</span>);
<a name="l00179"></a>00179 console->Printf(KTxtNewLine); <span class="comment">// with trailing new-line</span>
<a name="l00180"></a>00180 CleanupStack::PopAndDestroy(); <span class="comment">// two-phase object</span>
<a name="l00181"></a>00181 <span class="comment">// concrete instance of an abstract class</span>
<a name="l00182"></a>00182 CAbstract* <span class="keyword">abstract</span>=CConcrete::NewLC(9);
<a name="l00183"></a>00183 <span class="comment">// new concrete object, but refer to it with abstract pointer</span>
<a name="l00184"></a>00184 <span class="keyword">abstract</span>->SomeFunction(11); <span class="comment">// do something with it</span>
<a name="l00185"></a>00185 CleanupStack::PopAndDestroy(); <span class="comment">// abstract object</span>
<a name="l00186"></a>00186 }
</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>