Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_c_inverter_8h_source.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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/Base/MessageQueueExample/Inverter/inc/CInverter.h 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/Base/MessageQueueExample/Inverter/inc/CInverter.h</h1><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 &quot;Eclipse Public License v1.0&quot;</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 &quot;http://www.eclipse.org/legal/epl-v10.html&quot;.</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">#ifndef CINVERTER_H_</span>
<a name="l00017"></a>00017 <span class="preprocessor"></span><span class="preprocessor">#define CINVERTER_H_</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#include &quot;e32base.h&quot;</span> <span class="comment">//for using CPeriodic</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &quot;e32msgqueue.h&quot;</span> 
<a name="l00020"></a>00020 
<a name="l00021"></a><a class="code" href="class_c_inverter.html">00021</a> <span class="keyword">class </span><a class="code" href="class_c_inverter.html">CInverter</a> 
<a name="l00022"></a>00022 {
<a name="l00023"></a>00023 <span class="keyword">public</span>:
<a name="l00024"></a>00024         <span class="keyword">static</span> <a class="code" href="class_c_inverter.html">CInverter</a>* NewL();
<a name="l00025"></a>00025         <span class="keyword">virtual</span> <a class="code" href="class_c_inverter.html#a6a742db9903aabd02203d158e5905135">~CInverter</a>();
<a name="l00026"></a>00026         <span class="keywordtype">void</span> Start();
<a name="l00027"></a>00027         
<a name="l00028"></a>00028         <span class="comment">//Recieve message from the messagequeue.</span>
<a name="l00029"></a>00029         TInt <a class="code" href="class_c_inverter.html#a04f57f2574053f65550decfa5f5b0a81">RecieveMsg</a>();      
<a name="l00030"></a>00030         
<a name="l00031"></a>00031         <span class="comment">//Send message to the InverterOutQ.</span>
<a name="l00032"></a>00032         <span class="keywordtype">void</span> <a class="code" href="class_c_inverter.html#afa8f1fa7a66c8f8aa461f84316fe4a0e">SendMsg</a>();         
<a name="l00033"></a>00033         
<a name="l00034"></a>00034         <span class="keywordtype">void</span> <a class="code" href="class_c_inverter.html#a5b46657c2749a4a0b364e5fb54a272de">Stop</a>();  
<a name="l00035"></a>00035         
<a name="l00036"></a>00036         <span class="comment">//A callback function to be called whenever the timer expires after certain interval of time . </span>
<a name="l00037"></a>00037         TInt <span class="keyword">static</span> <a class="code" href="class_c_inverter.html#a5eaf28a9caffc96fa285871dd1b52f97">StaticWake</a>(TAny*); 
<a name="l00038"></a>00038         
<a name="l00039"></a>00039         <span class="keywordtype">void</span> <a class="code" href="class_c_inverter.html#a79ad184aaf5ee5bf48a8bb724a188614">ConstructL</a>();
<a name="l00040"></a>00040         
<a name="l00041"></a>00041         <span class="comment">//Invert the user words input by the user.</span>
<a name="l00042"></a>00042         <span class="keywordtype">void</span> <a class="code" href="class_c_inverter.html#a120fb0b63f1b40f9ec514733724e8824">DoInvert</a>();
<a name="l00043"></a>00043         
<a name="l00044"></a>00044         <span class="comment">//Reverse the word of the sentence coming to the Inverter.</span>
<a name="l00045"></a>00045         <span class="keywordtype">void</span> <a class="code" href="class_c_inverter.html#a685b043131942beefd2f4fc886379475">ReverseWord</a>(TBuf&lt;20&gt; buf);
<a name="l00046"></a>00046         
<a name="l00047"></a>00047 <span class="keyword">private</span>:
<a name="l00048"></a>00048         <span class="comment">// A periodic timer to be used to wake the inverter to start recieving the messages . </span>
<a name="l00049"></a>00049         CPeriodic *iTimer;
<a name="l00050"></a>00050         
<a name="l00051"></a>00051         <span class="comment">//Message queues to be opened and used to send data to inverter. </span>
<a name="l00052"></a>00052         RMsgQueue &lt;TBuf&lt;100&gt; &gt; iOutMsgQ;          
<a name="l00053"></a>00053         
<a name="l00054"></a>00054         <span class="comment">//Message queues to be opened and used to recieve data from inverter. </span>
<a name="l00055"></a>00055         RMsgQueue &lt;TBuf&lt;100&gt; &gt; iInMsgQ;
<a name="l00056"></a>00056         
<a name="l00057"></a>00057         <span class="comment">//Buffer to store inverted message.</span>
<a name="l00058"></a>00058         TBuf&lt;100&gt; iMsgQData; 
<a name="l00059"></a>00059         
<a name="l00060"></a>00060         <span class="comment">//Buffer to store the message to be sent to InverterOutQ.</span>
<a name="l00061"></a>00061         TBuf&lt;100&gt; idestMsg;
<a name="l00062"></a>00062         
<a name="l00063"></a>00063         <span class="comment">//Temporary buffers to reverse the words of the sentence.</span>
<a name="l00064"></a>00064         TBuf&lt;20&gt; iwords;
<a name="l00065"></a>00065         TBuf&lt;20&gt; itmpWord; 
<a name="l00066"></a>00066 };
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 <span class="preprocessor">#endif </span><span class="comment">/*CINVERTER_H_*/</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>