Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_inverter.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: CInverter Class Reference</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>CInverter Class Reference</h1><!-- doxytag: class="CInverter" -->
<p>
<a href="class_c_inverter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#6a742db9903aabd02203d158e5905135">~CInverter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60c29d84f46d0527afb1474abdc7a37a"></a><!-- doxytag: member="CInverter::Start" ref="60c29d84f46d0527afb1474abdc7a37a" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>Start</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#04f57f2574053f65550decfa5f5b0a81">RecieveMsg</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#fa8f1fa7a66c8f8aa461f84316fe4a0e">SendMsg</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#5b46657c2749a4a0b364e5fb54a272de">Stop</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#79ad184aaf5ee5bf48a8bb724a188614">ConstructL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#120fb0b63f1b40f9ec514733724e8824">DoInvert</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#685b043131942beefd2f4fc886379475">ReverseWord</a> (TBuf< 20 > buf)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffd7481b98a4a9be86f12a45a1a2e056"></a><!-- doxytag: member="CInverter::NewL" ref="ffd7481b98a4a9be86f12a45a1a2e056" args="()" -->
static <a class="el" href="class_c_inverter.html">CInverter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#ffd7481b98a4a9be86f12a45a1a2e056">NewL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#5eaf28a9caffc96fa285871dd1b52f97">StaticWake</a> (TAny *)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_c_inverter_8h-source.html#l00021">21</a> of file <a class="el" href="_c_inverter_8h-source.html">CInverter.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="6a742db9903aabd02203d158e5905135"></a><!-- doxytag: member="CInverter::~CInverter" ref="6a742db9903aabd02203d158e5905135" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CInverter::~CInverter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor, cancels the periodic timer, close the message queues.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00037">37</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="04f57f2574053f65550decfa5f5b0a81"></a><!-- doxytag: member="CInverter::RecieveMsg" ref="04f57f2574053f65550decfa5f5b0a81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CInverter::RecieveMsg </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The following function opens the InveterInQ message queue and recieves data from it. If the recieved message indicates stop command given by the first process, it stops the timer and closes the message queue etc. This function is called at a regular interval of 5 secs, so every five seconds data is recieved by this process.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00090">90</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="fa8f1fa7a66c8f8aa461f84316fe4a0e"></a><!-- doxytag: member="CInverter::SendMsg" ref="fa8f1fa7a66c8f8aa461f84316fe4a0e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CInverter::SendMsg </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The following function will send the message to the message queue after inverting the words.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00116">116</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="5b46657c2749a4a0b364e5fb54a272de"></a><!-- doxytag: member="CInverter::Stop" ref="5b46657c2749a4a0b364e5fb54a272de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CInverter::Stop </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function is called when user gives stop command, it closes the message queue, stops the scheduler and cancels the timer.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00173">173</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="5eaf28a9caffc96fa285871dd1b52f97"></a><!-- doxytag: member="CInverter::StaticWake" ref="5eaf28a9caffc96fa285871dd1b52f97" args="(TAny *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CInverter::StaticWake </td>
<td>(</td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aAny</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The following function is called periodically at an interval specified in the Start function of the CPeriodic class.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00075">75</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="79ad184aaf5ee5bf48a8bb724a188614"></a><!-- doxytag: member="CInverter::ConstructL" ref="79ad184aaf5ee5bf48a8bb724a188614" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CInverter::ConstructL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a periodic timer and starts the timer function.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00060">60</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="120fb0b63f1b40f9ec514733724e8824"></a><!-- doxytag: member="CInverter::DoInvert" ref="120fb0b63f1b40f9ec514733724e8824" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CInverter::DoInvert </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The following function inverts words in the sentence, recieved by the message queue.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00133">133</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="685b043131942beefd2f4fc886379475"></a><!-- doxytag: member="CInverter::ReverseWord" ref="685b043131942beefd2f4fc886379475" args="(TBuf< 20 > buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CInverter::ReverseWord </td>
<td>(</td>
<td class="paramtype">TBuf< 20 > </td>
<td class="paramname"> <em>buf</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reverse the individual words of the sentence, filtered in the function above.
<p>Definition at line <a class="el" href="_c_inverter_8cpp-source.html#l00159">159</a> of file <a class="el" href="_c_inverter_8cpp-source.html">CInverter.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:06 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>