Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_inverter.html
changeset 1 25a17d01db0c
child 6 43e37759235e
equal deleted inserted replaced
0:89d6a7a84779 1:25a17d01db0c
       
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
       
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
       
     3 <title>TB10.1 Example Applications: CInverter Class Reference</title>
       
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
       
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
       
     6 </head><body>
       
     7 <!-- Generated by Doxygen 1.5.3 -->
       
     8 <h1>CInverter Class Reference</h1><!-- doxytag: class="CInverter" -->
       
     9 <p>
       
    10 <a href="class_c_inverter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
       
    11 <tr><td></td></tr>
       
    12 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
       
    13 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#6a742db9903aabd02203d158e5905135">~CInverter</a> ()</td></tr>
       
    14 
       
    15 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60c29d84f46d0527afb1474abdc7a37a"></a><!-- doxytag: member="CInverter::Start" ref="60c29d84f46d0527afb1474abdc7a37a" args="()" -->
       
    16 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Start</b> ()</td></tr>
       
    17 
       
    18 <tr><td class="memItemLeft" nowrap align="right" valign="top">TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#04f57f2574053f65550decfa5f5b0a81">RecieveMsg</a> ()</td></tr>
       
    19 
       
    20 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#fa8f1fa7a66c8f8aa461f84316fe4a0e">SendMsg</a> ()</td></tr>
       
    21 
       
    22 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#5b46657c2749a4a0b364e5fb54a272de">Stop</a> ()</td></tr>
       
    23 
       
    24 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#79ad184aaf5ee5bf48a8bb724a188614">ConstructL</a> ()</td></tr>
       
    25 
       
    26 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#120fb0b63f1b40f9ec514733724e8824">DoInvert</a> ()</td></tr>
       
    27 
       
    28 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#685b043131942beefd2f4fc886379475">ReverseWord</a> (TBuf&lt; 20 &gt; buf)</td></tr>
       
    29 
       
    30 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
       
    31 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffd7481b98a4a9be86f12a45a1a2e056"></a><!-- doxytag: member="CInverter::NewL" ref="ffd7481b98a4a9be86f12a45a1a2e056" args="()" -->
       
    32 static <a class="el" href="class_c_inverter.html">CInverter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#ffd7481b98a4a9be86f12a45a1a2e056">NewL</a> ()</td></tr>
       
    33 
       
    34 <tr><td class="memItemLeft" nowrap align="right" valign="top">static TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_inverter.html#5eaf28a9caffc96fa285871dd1b52f97">StaticWake</a> (TAny *)</td></tr>
       
    35 
       
    36 </table>
       
    37 <hr><a name="_details"></a><h2>Detailed Description</h2>
       
    38 
       
    39 <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>
       
    40 <hr><h2>Constructor &amp; Destructor Documentation</h2>
       
    41 <a class="anchor" name="6a742db9903aabd02203d158e5905135"></a><!-- doxytag: member="CInverter::~CInverter" ref="6a742db9903aabd02203d158e5905135" args="()" -->
       
    42 <div class="memitem">
       
    43 <div class="memproto">
       
    44       <table class="memname">
       
    45         <tr>
       
    46           <td class="memname">CInverter::~CInverter           </td>
       
    47           <td>(</td>
       
    48           <td class="paramname">          </td>
       
    49           <td>&nbsp;)&nbsp;</td>
       
    50           <td width="100%"><code> [virtual]</code></td>
       
    51         </tr>
       
    52       </table>
       
    53 </div>
       
    54 <div class="memdoc">
       
    55 
       
    56 <p>
       
    57 Destructor, cancels the periodic timer, close the message queues. 
       
    58 <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>
       
    59 
       
    60 </div>
       
    61 </div><p>
       
    62 <hr><h2>Member Function Documentation</h2>
       
    63 <a class="anchor" name="04f57f2574053f65550decfa5f5b0a81"></a><!-- doxytag: member="CInverter::RecieveMsg" ref="04f57f2574053f65550decfa5f5b0a81" args="()" -->
       
    64 <div class="memitem">
       
    65 <div class="memproto">
       
    66       <table class="memname">
       
    67         <tr>
       
    68           <td class="memname">TInt CInverter::RecieveMsg           </td>
       
    69           <td>(</td>
       
    70           <td class="paramname">          </td>
       
    71           <td>&nbsp;)&nbsp;</td>
       
    72           <td width="100%"></td>
       
    73         </tr>
       
    74       </table>
       
    75 </div>
       
    76 <div class="memdoc">
       
    77 
       
    78 <p>
       
    79 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. 
       
    80 <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>
       
    81 
       
    82 </div>
       
    83 </div><p>
       
    84 <a class="anchor" name="fa8f1fa7a66c8f8aa461f84316fe4a0e"></a><!-- doxytag: member="CInverter::SendMsg" ref="fa8f1fa7a66c8f8aa461f84316fe4a0e" args="()" -->
       
    85 <div class="memitem">
       
    86 <div class="memproto">
       
    87       <table class="memname">
       
    88         <tr>
       
    89           <td class="memname">void CInverter::SendMsg           </td>
       
    90           <td>(</td>
       
    91           <td class="paramname">          </td>
       
    92           <td>&nbsp;)&nbsp;</td>
       
    93           <td width="100%"></td>
       
    94         </tr>
       
    95       </table>
       
    96 </div>
       
    97 <div class="memdoc">
       
    98 
       
    99 <p>
       
   100 The following function will send the message to the message queue after inverting the words. 
       
   101 <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>
       
   102 
       
   103 </div>
       
   104 </div><p>
       
   105 <a class="anchor" name="5b46657c2749a4a0b364e5fb54a272de"></a><!-- doxytag: member="CInverter::Stop" ref="5b46657c2749a4a0b364e5fb54a272de" args="()" -->
       
   106 <div class="memitem">
       
   107 <div class="memproto">
       
   108       <table class="memname">
       
   109         <tr>
       
   110           <td class="memname">void CInverter::Stop           </td>
       
   111           <td>(</td>
       
   112           <td class="paramname">          </td>
       
   113           <td>&nbsp;)&nbsp;</td>
       
   114           <td width="100%"></td>
       
   115         </tr>
       
   116       </table>
       
   117 </div>
       
   118 <div class="memdoc">
       
   119 
       
   120 <p>
       
   121 This function is called when user gives stop command, it closes the message queue, stops the scheduler and cancels the timer. 
       
   122 <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>
       
   123 
       
   124 </div>
       
   125 </div><p>
       
   126 <a class="anchor" name="5eaf28a9caffc96fa285871dd1b52f97"></a><!-- doxytag: member="CInverter::StaticWake" ref="5eaf28a9caffc96fa285871dd1b52f97" args="(TAny *)" -->
       
   127 <div class="memitem">
       
   128 <div class="memproto">
       
   129       <table class="memname">
       
   130         <tr>
       
   131           <td class="memname">TInt CInverter::StaticWake           </td>
       
   132           <td>(</td>
       
   133           <td class="paramtype">TAny *&nbsp;</td>
       
   134           <td class="paramname"> <em>aAny</em>          </td>
       
   135           <td>&nbsp;)&nbsp;</td>
       
   136           <td width="100%"><code> [static]</code></td>
       
   137         </tr>
       
   138       </table>
       
   139 </div>
       
   140 <div class="memdoc">
       
   141 
       
   142 <p>
       
   143 The following function is called periodically at an interval specified in the Start function of the CPeriodic class. 
       
   144 <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>
       
   145 
       
   146 </div>
       
   147 </div><p>
       
   148 <a class="anchor" name="79ad184aaf5ee5bf48a8bb724a188614"></a><!-- doxytag: member="CInverter::ConstructL" ref="79ad184aaf5ee5bf48a8bb724a188614" args="()" -->
       
   149 <div class="memitem">
       
   150 <div class="memproto">
       
   151       <table class="memname">
       
   152         <tr>
       
   153           <td class="memname">void CInverter::ConstructL           </td>
       
   154           <td>(</td>
       
   155           <td class="paramname">          </td>
       
   156           <td>&nbsp;)&nbsp;</td>
       
   157           <td width="100%"></td>
       
   158         </tr>
       
   159       </table>
       
   160 </div>
       
   161 <div class="memdoc">
       
   162 
       
   163 <p>
       
   164 Construct a periodic timer and starts the timer function. 
       
   165 <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>
       
   166 
       
   167 </div>
       
   168 </div><p>
       
   169 <a class="anchor" name="120fb0b63f1b40f9ec514733724e8824"></a><!-- doxytag: member="CInverter::DoInvert" ref="120fb0b63f1b40f9ec514733724e8824" args="()" -->
       
   170 <div class="memitem">
       
   171 <div class="memproto">
       
   172       <table class="memname">
       
   173         <tr>
       
   174           <td class="memname">void CInverter::DoInvert           </td>
       
   175           <td>(</td>
       
   176           <td class="paramname">          </td>
       
   177           <td>&nbsp;)&nbsp;</td>
       
   178           <td width="100%"></td>
       
   179         </tr>
       
   180       </table>
       
   181 </div>
       
   182 <div class="memdoc">
       
   183 
       
   184 <p>
       
   185 The following function inverts words in the sentence, recieved by the message queue. 
       
   186 <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>
       
   187 
       
   188 </div>
       
   189 </div><p>
       
   190 <a class="anchor" name="685b043131942beefd2f4fc886379475"></a><!-- doxytag: member="CInverter::ReverseWord" ref="685b043131942beefd2f4fc886379475" args="(TBuf&lt; 20 &gt; buf)" -->
       
   191 <div class="memitem">
       
   192 <div class="memproto">
       
   193       <table class="memname">
       
   194         <tr>
       
   195           <td class="memname">void CInverter::ReverseWord           </td>
       
   196           <td>(</td>
       
   197           <td class="paramtype">TBuf&lt; 20 &gt;&nbsp;</td>
       
   198           <td class="paramname"> <em>buf</em>          </td>
       
   199           <td>&nbsp;)&nbsp;</td>
       
   200           <td width="100%"></td>
       
   201         </tr>
       
   202       </table>
       
   203 </div>
       
   204 <div class="memdoc">
       
   205 
       
   206 <p>
       
   207 Reverse the individual words of the sentence, filtered in the function above. 
       
   208 <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>
       
   209 
       
   210 </div>
       
   211 </div><p>
       
   212 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:06 2010 for TB10.1 Example Applications by&nbsp;
       
   213 <a href="http://www.doxygen.org/index.html">
       
   214 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
       
   215 </body>
       
   216 </html>