Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_simple_class_8cpp-source.html
week 10 bug fix submission: Bug 1892, Bug 1897, Bug 1319. Also 3 or 4 documents were found to contain code blocks with SFL, which has been fixed. Partial fix for broken links, links to Forum Nokia, and the 'Symbian platform' terminology issues.
<!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/SysLibs/Streaming/SimpleClass/SimpleClass.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/SysLibs/Streaming/SimpleClass/SimpleClass.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">// Example to demonstrate simple use of Streaming</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 <span class="preprocessor">#include "CommonStreamStore.h"</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <s32file.h></span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">// Constructs a TSimple object and </span>
<a name="l00022"></a>00022 <span class="comment">// externalizes it to a single stream.</span>
<a name="l00023"></a>00023 <span class="keyword">static</span> <span class="keywordtype">void</span> doMakeAndExternalizeL(<span class="keyword">const</span> TDesC& aName);
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">// Internalizes a TSimple object from</span>
<a name="l00026"></a>00026 <span class="comment">// the stream</span>
<a name="l00027"></a>00027 <span class="keyword">static</span> <span class="keywordtype">void</span> doInternalizeL(<span class="keyword">const</span> TDesC& aName);
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="comment">// Displays content of a TSimple object</span>
<a name="l00030"></a>00030 <span class="keyword">class </span>TSimple;
<a name="l00031"></a>00031 <span class="keyword">static</span> <span class="keywordtype">void</span> doShow(<span class="keyword">const</span> TDesC& aHeading,<span class="keyword">const</span> TSimple& theSimple);
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="comment">// enumeration used by the TSimple class</span>
<a name="l00034"></a>00034 <span class="keyword">enum</span> TXxx {EX1,EX2,EX3};
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">// definition of the TSimple class</span>
<a name="l00037"></a>00037 <span class="keyword">class </span>TSimple
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">public</span> :
<a name="l00040"></a>00040 <span class="keywordtype">void</span> ExternalizeL(RWriteStream& aStream) <span class="keyword">const</span>;
<a name="l00041"></a>00041 <span class="keywordtype">void</span> InternalizeL(RReadStream& aStream);
<a name="l00042"></a>00042 <span class="keyword">public</span> :
<a name="l00043"></a>00043 TXxx iTheEnum;
<a name="l00044"></a>00044 TBuf<32> iBuffer;
<a name="l00045"></a>00045 TInt iIntValue;
<a name="l00046"></a>00046 TUint iUintValue;
<a name="l00047"></a>00047 TReal iRealValue;
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">// The file name, extension and path for the file store</span>
<a name="l00052"></a>00052 _LIT(KFullNameOfFileStore,<span class="stringliteral">"\\epoc32ex\\data\\SimpleClassToSimpleStream.dat"</span>);
<a name="l00053"></a>00053
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">// Do the example</span>
<a name="l00056"></a>00056 <span class="keyword">static</span> <span class="keywordtype">void</span> doExampleL()
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 <span class="comment">// make sure directory exists</span>
<a name="l00059"></a>00059 fsSession.MkDirAll(KFullNameOfFileStore);
<a name="l00060"></a>00060 doMakeAndExternalizeL(KFullNameOfFileStore);
<a name="l00061"></a>00061 doInternalizeL(KFullNameOfFileStore);
<a name="l00062"></a>00062 }
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keyword">static</span> <span class="keywordtype">void</span> doMakeAndExternalizeL(<span class="keyword">const</span> TDesC& aName)
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 TParse filestorename;
<a name="l00067"></a>00067 fsSession.Parse(aName,filestorename);
<a name="l00068"></a>00068 <span class="comment">// construct file store object - the file to contain the</span>
<a name="l00069"></a>00069 <span class="comment">// the store replaces any existing file of the same name.</span>
<a name="l00070"></a>00070 CFileStore* store = CDirectFileStore::ReplaceLC(fsSession,filestorename.FullName(),EFileWrite);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">// Must say what kind of file store</span>
<a name="l00073"></a>00073 store->SetTypeL(KDirectFileStoreLayoutUid);
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Construct an object of type TSimple and put some </span>
<a name="l00076"></a>00076 <span class="comment">// data into it</span>
<a name="l00077"></a>00077 _LIT(KTxtSomeText,<span class="stringliteral">"Some text"</span>);
<a name="l00078"></a>00078 TSimple thesimple;
<a name="l00079"></a>00079 thesimple.iTheEnum = EX3;
<a name="l00080"></a>00080 thesimple.iBuffer = KTxtSomeText;
<a name="l00081"></a>00081 thesimple.iIntValue = -1;
<a name="l00082"></a>00082 thesimple.iUintValue = 2;
<a name="l00083"></a>00083 thesimple.iRealValue = 3.4;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">// Show contents of the TSimple object</span>
<a name="l00086"></a>00086 _LIT(KTxtTSimpleContent,<span class="stringliteral">"TSimple content ..."</span>);
<a name="l00087"></a>00087 doShow(KTxtTSimpleContent,thesimple);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="comment">// Construct and create the output stream</span>
<a name="l00090"></a>00090 <span class="comment">// object. </span>
<a name="l00091"></a>00091 <span class="comment">// The stream id (there is only one) will</span>
<a name="l00092"></a>00092 <span class="comment">// be saved (later) in the store as the </span>
<a name="l00093"></a>00093 <span class="comment">// root stream id</span>
<a name="l00094"></a>00094 RStoreWriteStream outstream;
<a name="l00095"></a>00095 TStreamId <span class="keywordtype">id</span> = outstream.CreateLC(*store);
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">// Stream out the TSimple object</span>
<a name="l00098"></a>00098 outstream << thesimple;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">// Commit changes to the stream</span>
<a name="l00101"></a>00101 outstream.CommitL();
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">// Cleanup the stream object</span>
<a name="l00104"></a>00104 CleanupStack::PopAndDestroy();
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="comment">// Set the stream id as the root</span>
<a name="l00107"></a>00107 store->SetRootL(<span class="keywordtype">id</span>);
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">// Commit changes to the store</span>
<a name="l00110"></a>00110 store->CommitL();
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// destroy the store object (this also closes</span>
<a name="l00113"></a>00113 <span class="comment">// the file containing the store) </span>
<a name="l00114"></a>00114 CleanupStack::PopAndDestroy();
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">static</span> <span class="keywordtype">void</span> doInternalizeL(<span class="keyword">const</span> TDesC& aName)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 TParse filestorename;
<a name="l00120"></a>00120 fsSession.Parse(aName,filestorename);
<a name="l00121"></a>00121 <span class="comment">// construct file store object - specifying the file</span>
<a name="l00122"></a>00122 <span class="comment">// containing the store.</span>
<a name="l00123"></a>00123 CFileStore* store = CDirectFileStore::OpenLC(fsSession,filestorename.FullName(),EFileRead);
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">// Construct and open the input stream object. We want </span>
<a name="l00126"></a>00126 <span class="comment">// to access the root stream from the store</span>
<a name="l00127"></a>00127 <span class="comment">// in this example. </span>
<a name="l00128"></a>00128 RStoreReadStream instream;
<a name="l00129"></a>00129 instream.OpenLC(*store,store->Root());
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">// Stream in the TSimple object</span>
<a name="l00132"></a>00132 TSimple thesimple;
<a name="l00133"></a>00133 instream >> thesimple;
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="comment">// Cleanup the stream object</span>
<a name="l00136"></a>00136 CleanupStack::PopAndDestroy();
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">// destroy the store object (this also closes the file</span>
<a name="l00139"></a>00139 <span class="comment">// containing the store) </span>
<a name="l00140"></a>00140 CleanupStack::PopAndDestroy();
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="comment">// Show contents of the TSimple object</span>
<a name="l00143"></a>00143 _LIT(KTxtRestoredTSimpleContent,<span class="stringliteral">"Restored TSimple content ..."</span>);
<a name="l00144"></a>00144 doShow(KTxtRestoredTSimpleContent,thesimple);
<a name="l00145"></a>00145 }
<a name="l00146"></a>00146
<a name="l00147"></a>00147 _LIT(KTxtNewLine,<span class="stringliteral">"\n"</span>);
<a name="l00148"></a>00148 _LIT(KFormatType1,<span class="stringliteral">"\n%d"</span>);
<a name="l00149"></a>00149 _LIT(KFormatType2,<span class="stringliteral">"\n%S"</span>);
<a name="l00150"></a>00150 _LIT(KFormatType3,<span class="stringliteral">"\n%u"</span>);
<a name="l00151"></a>00151 _LIT(KFormatType4,<span class="stringliteral">"\n%f"</span>);
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keyword">static</span> <span class="keywordtype">void</span> doShow(<span class="keyword">const</span> TDesC& aHeading,<span class="keyword">const</span> TSimple& aSimple)
<a name="l00154"></a>00154 {
<a name="l00155"></a>00155 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(KTxtNewLine);
<a name="l00156"></a>00156 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(aHeading);
<a name="l00157"></a>00157 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(KFormatType1,aSimple.iTheEnum);
<a name="l00158"></a>00158 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(KFormatType2,&aSimple.iBuffer);
<a name="l00159"></a>00159 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(KFormatType1,aSimple.iIntValue);
<a name="l00160"></a>00160 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(KFormatType3,aSimple.iUintValue);
<a name="l00161"></a>00161 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(KFormatType4,aSimple.iRealValue);
<a name="l00162"></a>00162 <a class="code" href="dbllist_8cpp.html#d789d40251baeb2f60e118de4856583d">console</a>->Printf(KTxtNewLine);
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="comment">//***************************************************************</span>
<a name="l00166"></a>00166 <span class="comment">//***************************************************************</span>
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="comment">// Explicit versions of the << and >> operators written to handle the</span>
<a name="l00169"></a>00169 <span class="comment">// enumerator type TXxx </span>
<a name="l00170"></a>00170
<a name="l00171"></a>00171 RWriteStream& operator<<(RWriteStream& aStream, <span class="keyword">const</span> TXxx& anXxx)
<a name="l00172"></a>00172 {
<a name="l00173"></a>00173 aStream.WriteInt8L(anXxx);
<a name="l00174"></a>00174 <span class="keywordflow">return</span> aStream;
<a name="l00175"></a>00175 }
<a name="l00176"></a>00176
<a name="l00177"></a>00177 RReadStream& operator>>(RReadStream& aStream, TXxx& anXxx)
<a name="l00178"></a>00178 {
<a name="l00179"></a>00179 anXxx = TXxx(aStream.ReadInt8L());
<a name="l00180"></a>00180 <span class="keywordflow">return</span> aStream;
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="comment">//***************************************************************</span>
<a name="l00184"></a>00184 <span class="comment">//***************************************************************</span>
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="keywordtype">void</span> TSimple::ExternalizeL(RWriteStream& aStream)<span class="keyword"> const</span>
<a name="l00187"></a>00187 <span class="keyword"> </span>{
<a name="l00188"></a>00188 aStream << iTheEnum;
<a name="l00189"></a>00189 aStream << <a class="code" href="class_c_class_a.html#bd3334f0db82391bb58a56fd1fa82537">iBuffer</a>;
<a name="l00190"></a>00190 aStream.WriteInt32L(<a class="code" href="class_c_class_a.html#60f1b308c9d6d983f30b47efcf610c93">iIntValue</a>);
<a name="l00191"></a>00191 aStream.WriteUint32L(<a class="code" href="class_c_class_a.html#07a6aaec0d0f70daa366d2a00d075a90">iUintValue</a>);
<a name="l00192"></a>00192 aStream.WriteReal64L(iRealValue);
<a name="l00193"></a>00193 }
<a name="l00194"></a>00194
<a name="l00195"></a>00195 <span class="keywordtype">void</span> TSimple::InternalizeL(RReadStream& aStream)
<a name="l00196"></a>00196 {
<a name="l00197"></a>00197 aStream >> iTheEnum;
<a name="l00198"></a>00198 aStream >> iBuffer;
<a name="l00199"></a>00199 <a class="code" href="class_c_class_a.html#60f1b308c9d6d983f30b47efcf610c93">iIntValue</a> = aStream.ReadInt32L();
<a name="l00200"></a>00200 <a class="code" href="class_c_class_a.html#07a6aaec0d0f70daa366d2a00d075a90">iUintValue</a> = aStream.ReadUint32L();
<a name="l00201"></a>00201 iRealValue = aStream.ReadReal64L();
<a name="l00202"></a>00202 }
<a name="l00203"></a>00203
<a name="l00204"></a>00204
<a name="l00205"></a>00205
<a name="l00206"></a>00206
<a name="l00207"></a>00207
<a name="l00208"></a>00208
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:01 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>