Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_collector.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: CCollector Class Reference</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 -->
<div class="contents">
<h1>CCollector Class Reference</h1><!-- doxytag: class="CCollector" -->
<p><a href="class_c_collector-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>TRequestType</b> { <b>ECount</b>,
<b>EStop</b>
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#a62eb0d5618f19c12f0e2fde477ce6e33">CCollector</a> (TInt aPriority=EPriorityStandard)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab481a566c8bf980c2412b81652da56d6"></a><!-- doxytag: member="CCollector::DoCancel" ref="ab481a566c8bf980c2412b81652da56d6" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>DoCancel</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#afeea3cfdbcd23f07b9c02ac93e87cf81">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#a3ed2cf3df9b76aa36ff1052f9144f94a">RequestFunction</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#ad038923135df997b7c8d121c63a4cf29">Stop</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#a7324ad866c1c03594465d5549aec5546">ConstructL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#ad2b71e3272b298ba8ca40dc4049cca07">ProcessKeyPress</a> (TChar aChar)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#ac93385f6f18c9e3a6d0fb92a989acb67">StartRecieving</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#ad22077e2d9c23fb39e4073ccacd1ee89">SendMsgInQ</a> (TBuf< 100 >)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb28513307efc70defd9dcea6827993e"></a><!-- doxytag: member="CCollector::NewL" ref="acb28513307efc70defd9dcea6827993e" args="(TInt aPriority=EPriorityStandard)" -->
static <a class="el" href="class_c_collector.html">CCollector</a> * </td><td class="memItemRight" valign="bottom"><b>NewL</b> (TInt aPriority=EPriorityStandard)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_c_collector_8h_source.html#l00028">28</a> of file <a class="el" href="_c_collector_8h_source.html">CCollector.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a62eb0d5618f19c12f0e2fde477ce6e33"></a><!-- doxytag: member="CCollector::CCollector" ref="a62eb0d5618f19c12f0e2fde477ce6e33" args="(TInt aPriority=EPriorityStandard)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCollector::CCollector </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aPriority</em> = <code>EPriorityStandard</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00035">35</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afeea3cfdbcd23f07b9c02ac93e87cf81"></a><!-- doxytag: member="CCollector::RunL" ref="afeea3cfdbcd23f07b9c02ac93e87cf81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCollector::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Store the characters input by the user in a buffer. </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00095">95</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3ed2cf3df9b76aa36ff1052f9144f94a"></a><!-- doxytag: member="CCollector::RequestFunction" ref="a3ed2cf3df9b76aa36ff1052f9144f94a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCollector::RequestFunction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request for user input. </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00086">86</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad038923135df997b7c8d121c63a4cf29"></a><!-- doxytag: member="CCollector::Stop" ref="ad038923135df997b7c8d121c63a4cf29" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCollector::Stop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The following function sends the stop message to the inverter via the message queue. </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00131">131</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7324ad866c1c03594465d5549aec5546"></a><!-- doxytag: member="CCollector::ConstructL" ref="a7324ad866c1c03594465d5549aec5546" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCollector::ConstructL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The constructor creates a console for requesting words from the user, creates two global message queues, starts the other process named Inverter.exe and create another active object to recieve words from the inverter. </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00054">54</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad2b71e3272b298ba8ca40dc4049cca07"></a><!-- doxytag: member="CCollector::ProcessKeyPress" ref="ad2b71e3272b298ba8ca40dc4049cca07" args="(TChar aChar)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCollector::ProcessKeyPress </td>
<td>(</td>
<td class="paramtype">TChar </td>
<td class="paramname"> <em>aChar</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The following function processes the key pressed by the user, stores in a buffer and sends the data to the inverter via collector. </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00108">108</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac93385f6f18c9e3a6d0fb92a989acb67"></a><!-- doxytag: member="CCollector::StartRecieving" ref="ac93385f6f18c9e3a6d0fb92a989acb67" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCollector::StartRecieving </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The following function calls the asynchronous request to recieve the words from the inverter. </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00150">150</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad22077e2d9c23fb39e4073ccacd1ee89"></a><!-- doxytag: member="CCollector::SendMsgInQ" ref="ad22077e2d9c23fb39e4073ccacd1ee89" args="(TBuf< 100 >)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCollector::SendMsgInQ </td>
<td>(</td>
<td class="paramtype">TBuf< 100 > </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The following function sends the message to InverterInQ. </p>
<p>Definition at line <a class="el" href="_c_collector_8cpp_source.html#l00158">158</a> of file <a class="el" href="_c_collector_8cpp_source.html">CCollector.cpp</a>.</p>
</div>
</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>