Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_collector.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: CCollector 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>CCollector Class Reference</h1><!-- doxytag: class="CCollector" -->
<p>
<a href="class_c_collector-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#1560e5c28bb115e89e9baa2cf5392b6f">TRequestType</a> { <a class="el" href="class_c_collector.html#1560e5c28bb115e89e9baa2cf5392b6ff8e48b78dc6bb1169c6c66148ab720ce">ECount</a>,
<a class="el" href="class_c_collector.html#1560e5c28bb115e89e9baa2cf5392b6fd50bbe4e9df42eaa081023317db0b422">EStop</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#62eb0d5618f19c12f0e2fde477ce6e33">CCollector</a> (TInt aPriority=EPriorityStandard)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b481a566c8bf980c2412b81652da56d6"></a><!-- doxytag: member="CCollector::DoCancel" ref="b481a566c8bf980c2412b81652da56d6" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#b481a566c8bf980c2412b81652da56d6">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#feea3cfdbcd23f07b9c02ac93e87cf81">RunL</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_collector.html#3ed2cf3df9b76aa36ff1052f9144f94a">RequestFunction</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_collector.html#d038923135df997b7c8d121c63a4cf29">Stop</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81e7bc728d692f9cd504c4d940d5b26d"></a><!-- doxytag: member="CCollector::~CCollector" ref="81e7bc728d692f9cd504c4d940d5b26d" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#81e7bc728d692f9cd504c4d940d5b26d">~CCollector</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_collector.html#7324ad866c1c03594465d5549aec5546">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_collector.html#d2b71e3272b298ba8ca40dc4049cca07">ProcessKeyPress</a> (TChar aChar)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#c93385f6f18c9e3a6d0fb92a989acb67">StartRecieving</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_collector.html#d22077e2d9c23fb39e4073ccacd1ee89">SendMsgInQ</a> (TBuf< 100 >)</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="cb28513307efc70defd9dcea6827993e"></a><!-- doxytag: member="CCollector::NewL" ref="cb28513307efc70defd9dcea6827993e" args="(TInt aPriority=EPriorityStandard)" -->
static <a class="el" href="class_c_collector.html">CCollector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#cb28513307efc70defd9dcea6827993e">NewL</a> (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>Member Enumeration Documentation</h2>
<a class="anchor" name="1560e5c28bb115e89e9baa2cf5392b6f"></a><!-- doxytag: member="CCollector::TRequestType" ref="1560e5c28bb115e89e9baa2cf5392b6f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_c_collector.html#1560e5c28bb115e89e9baa2cf5392b6f">CCollector::TRequestType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="1560e5c28bb115e89e9baa2cf5392b6ff8e48b78dc6bb1169c6c66148ab720ce"></a><!-- doxytag: member="ECount" ref="1560e5c28bb115e89e9baa2cf5392b6ff8e48b78dc6bb1169c6c66148ab720ce" args="" -->ECount</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="1560e5c28bb115e89e9baa2cf5392b6fd50bbe4e9df42eaa081023317db0b422"></a><!-- doxytag: member="EStop" ref="1560e5c28bb115e89e9baa2cf5392b6fd50bbe4e9df42eaa081023317db0b422" args="" -->EStop</em> </td><td>
</td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="_c_collector_8h-source.html#l00031">31</a> of file <a class="el" href="_c_collector_8h-source.html">CCollector.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="62eb0d5618f19c12f0e2fde477ce6e33"></a><!-- doxytag: member="CCollector::CCollector" ref="62eb0d5618f19c12f0e2fde477ce6e33" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor
<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><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="feea3cfdbcd23f07b9c02ac93e87cf81"></a><!-- doxytag: member="CCollector::RunL" ref="feea3cfdbcd23f07b9c02ac93e87cf81" 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 width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Store the characters input by the user in a buffer.
<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><p>
<a class="anchor" name="3ed2cf3df9b76aa36ff1052f9144f94a"></a><!-- doxytag: member="CCollector::RequestFunction" ref="3ed2cf3df9b76aa36ff1052f9144f94a" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Request for user input.
<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><p>
<a class="anchor" name="d038923135df997b7c8d121c63a4cf29"></a><!-- doxytag: member="CCollector::Stop" ref="d038923135df997b7c8d121c63a4cf29" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The following function sends the stop message to the inverter via the message queue.
<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><p>
<a class="anchor" name="7324ad866c1c03594465d5549aec5546"></a><!-- doxytag: member="CCollector::ConstructL" ref="7324ad866c1c03594465d5549aec5546" 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 width="100%"></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>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><p>
<a class="anchor" name="d2b71e3272b298ba8ca40dc4049cca07"></a><!-- doxytag: member="CCollector::ProcessKeyPress" ref="d2b71e3272b298ba8ca40dc4049cca07" 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 width="100%"></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>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><p>
<a class="anchor" name="c93385f6f18c9e3a6d0fb92a989acb67"></a><!-- doxytag: member="CCollector::StartRecieving" ref="c93385f6f18c9e3a6d0fb92a989acb67" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The following function calls the asynchronous request to recieve the words from the inverter.
<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><p>
<a class="anchor" name="d22077e2d9c23fb39e4073ccacd1ee89"></a><!-- doxytag: member="CCollector::SendMsgInQ" ref="d22077e2d9c23fb39e4073ccacd1ee89" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The following function sends the message to InverterInQ.
<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><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 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>