|
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: CCollector 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>CCollector Class Reference</h1><!-- doxytag: class="CCollector" --> |
|
9 <p> |
|
10 <a href="class_c_collector-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 Types</h2></td></tr> |
|
13 <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>, |
|
14 <a class="el" href="class_c_collector.html#1560e5c28bb115e89e9baa2cf5392b6fd50bbe4e9df42eaa081023317db0b422">EStop</a> |
|
15 }</td></tr> |
|
16 |
|
17 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
|
18 <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> |
|
19 |
|
20 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b481a566c8bf980c2412b81652da56d6"></a><!-- doxytag: member="CCollector::DoCancel" ref="b481a566c8bf980c2412b81652da56d6" args="()" --> |
|
21 virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#b481a566c8bf980c2412b81652da56d6">DoCancel</a> ()</td></tr> |
|
22 |
|
23 <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> |
|
24 |
|
25 <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> |
|
26 |
|
27 <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> |
|
28 |
|
29 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="81e7bc728d692f9cd504c4d940d5b26d"></a><!-- doxytag: member="CCollector::~CCollector" ref="81e7bc728d692f9cd504c4d940d5b26d" args="()" --> |
|
30 virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_collector.html#81e7bc728d692f9cd504c4d940d5b26d">~CCollector</a> ()</td></tr> |
|
31 |
|
32 <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> |
|
33 |
|
34 <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> |
|
35 |
|
36 <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> |
|
37 |
|
38 <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> |
|
39 |
|
40 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
|
41 <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)" --> |
|
42 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> |
|
43 |
|
44 </table> |
|
45 <hr><a name="_details"></a><h2>Detailed Description</h2> |
|
46 |
|
47 <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> |
|
48 <hr><h2>Member Enumeration Documentation</h2> |
|
49 <a class="anchor" name="1560e5c28bb115e89e9baa2cf5392b6f"></a><!-- doxytag: member="CCollector::TRequestType" ref="1560e5c28bb115e89e9baa2cf5392b6f" args="" --> |
|
50 <div class="memitem"> |
|
51 <div class="memproto"> |
|
52 <table class="memname"> |
|
53 <tr> |
|
54 <td class="memname">enum <a class="el" href="class_c_collector.html#1560e5c28bb115e89e9baa2cf5392b6f">CCollector::TRequestType</a> </td> |
|
55 </tr> |
|
56 </table> |
|
57 </div> |
|
58 <div class="memdoc"> |
|
59 |
|
60 <p> |
|
61 <dl compact><dt><b>Enumerator: </b></dt><dd> |
|
62 <table border="0" cellspacing="2" cellpadding="0"> |
|
63 <tr><td valign="top"><em><a class="anchor" name="1560e5c28bb115e89e9baa2cf5392b6ff8e48b78dc6bb1169c6c66148ab720ce"></a><!-- doxytag: member="ECount" ref="1560e5c28bb115e89e9baa2cf5392b6ff8e48b78dc6bb1169c6c66148ab720ce" args="" -->ECount</em> </td><td> |
|
64 </td></tr> |
|
65 <tr><td valign="top"><em><a class="anchor" name="1560e5c28bb115e89e9baa2cf5392b6fd50bbe4e9df42eaa081023317db0b422"></a><!-- doxytag: member="EStop" ref="1560e5c28bb115e89e9baa2cf5392b6fd50bbe4e9df42eaa081023317db0b422" args="" -->EStop</em> </td><td> |
|
66 </td></tr> |
|
67 </table> |
|
68 </dl> |
|
69 |
|
70 <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> |
|
71 |
|
72 </div> |
|
73 </div><p> |
|
74 <hr><h2>Constructor & Destructor Documentation</h2> |
|
75 <a class="anchor" name="62eb0d5618f19c12f0e2fde477ce6e33"></a><!-- doxytag: member="CCollector::CCollector" ref="62eb0d5618f19c12f0e2fde477ce6e33" args="(TInt aPriority=EPriorityStandard)" --> |
|
76 <div class="memitem"> |
|
77 <div class="memproto"> |
|
78 <table class="memname"> |
|
79 <tr> |
|
80 <td class="memname">CCollector::CCollector </td> |
|
81 <td>(</td> |
|
82 <td class="paramtype">TInt </td> |
|
83 <td class="paramname"> <em>aPriority</em> = <code>EPriorityStandard</code> </td> |
|
84 <td> ) </td> |
|
85 <td width="100%"></td> |
|
86 </tr> |
|
87 </table> |
|
88 </div> |
|
89 <div class="memdoc"> |
|
90 |
|
91 <p> |
|
92 Constructor |
|
93 <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> |
|
94 |
|
95 </div> |
|
96 </div><p> |
|
97 <hr><h2>Member Function Documentation</h2> |
|
98 <a class="anchor" name="feea3cfdbcd23f07b9c02ac93e87cf81"></a><!-- doxytag: member="CCollector::RunL" ref="feea3cfdbcd23f07b9c02ac93e87cf81" args="()" --> |
|
99 <div class="memitem"> |
|
100 <div class="memproto"> |
|
101 <table class="memname"> |
|
102 <tr> |
|
103 <td class="memname">void CCollector::RunL </td> |
|
104 <td>(</td> |
|
105 <td class="paramname"> </td> |
|
106 <td> ) </td> |
|
107 <td width="100%"><code> [virtual]</code></td> |
|
108 </tr> |
|
109 </table> |
|
110 </div> |
|
111 <div class="memdoc"> |
|
112 |
|
113 <p> |
|
114 Store the characters input by the user in a buffer. |
|
115 <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> |
|
116 |
|
117 </div> |
|
118 </div><p> |
|
119 <a class="anchor" name="3ed2cf3df9b76aa36ff1052f9144f94a"></a><!-- doxytag: member="CCollector::RequestFunction" ref="3ed2cf3df9b76aa36ff1052f9144f94a" args="()" --> |
|
120 <div class="memitem"> |
|
121 <div class="memproto"> |
|
122 <table class="memname"> |
|
123 <tr> |
|
124 <td class="memname">void CCollector::RequestFunction </td> |
|
125 <td>(</td> |
|
126 <td class="paramname"> </td> |
|
127 <td> ) </td> |
|
128 <td width="100%"></td> |
|
129 </tr> |
|
130 </table> |
|
131 </div> |
|
132 <div class="memdoc"> |
|
133 |
|
134 <p> |
|
135 Request for user input. |
|
136 <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> |
|
137 |
|
138 </div> |
|
139 </div><p> |
|
140 <a class="anchor" name="d038923135df997b7c8d121c63a4cf29"></a><!-- doxytag: member="CCollector::Stop" ref="d038923135df997b7c8d121c63a4cf29" args="()" --> |
|
141 <div class="memitem"> |
|
142 <div class="memproto"> |
|
143 <table class="memname"> |
|
144 <tr> |
|
145 <td class="memname">void CCollector::Stop </td> |
|
146 <td>(</td> |
|
147 <td class="paramname"> </td> |
|
148 <td> ) </td> |
|
149 <td width="100%"></td> |
|
150 </tr> |
|
151 </table> |
|
152 </div> |
|
153 <div class="memdoc"> |
|
154 |
|
155 <p> |
|
156 The following function sends the stop message to the inverter via the message queue. |
|
157 <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> |
|
158 |
|
159 </div> |
|
160 </div><p> |
|
161 <a class="anchor" name="7324ad866c1c03594465d5549aec5546"></a><!-- doxytag: member="CCollector::ConstructL" ref="7324ad866c1c03594465d5549aec5546" args="()" --> |
|
162 <div class="memitem"> |
|
163 <div class="memproto"> |
|
164 <table class="memname"> |
|
165 <tr> |
|
166 <td class="memname">void CCollector::ConstructL </td> |
|
167 <td>(</td> |
|
168 <td class="paramname"> </td> |
|
169 <td> ) </td> |
|
170 <td width="100%"></td> |
|
171 </tr> |
|
172 </table> |
|
173 </div> |
|
174 <div class="memdoc"> |
|
175 |
|
176 <p> |
|
177 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. |
|
178 <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> |
|
179 |
|
180 </div> |
|
181 </div><p> |
|
182 <a class="anchor" name="d2b71e3272b298ba8ca40dc4049cca07"></a><!-- doxytag: member="CCollector::ProcessKeyPress" ref="d2b71e3272b298ba8ca40dc4049cca07" args="(TChar aChar)" --> |
|
183 <div class="memitem"> |
|
184 <div class="memproto"> |
|
185 <table class="memname"> |
|
186 <tr> |
|
187 <td class="memname">void CCollector::ProcessKeyPress </td> |
|
188 <td>(</td> |
|
189 <td class="paramtype">TChar </td> |
|
190 <td class="paramname"> <em>aChar</em> </td> |
|
191 <td> ) </td> |
|
192 <td width="100%"></td> |
|
193 </tr> |
|
194 </table> |
|
195 </div> |
|
196 <div class="memdoc"> |
|
197 |
|
198 <p> |
|
199 The following function processes the key pressed by the user, stores in a buffer and sends the data to the inverter via collector. |
|
200 <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> |
|
201 |
|
202 </div> |
|
203 </div><p> |
|
204 <a class="anchor" name="c93385f6f18c9e3a6d0fb92a989acb67"></a><!-- doxytag: member="CCollector::StartRecieving" ref="c93385f6f18c9e3a6d0fb92a989acb67" args="()" --> |
|
205 <div class="memitem"> |
|
206 <div class="memproto"> |
|
207 <table class="memname"> |
|
208 <tr> |
|
209 <td class="memname">void CCollector::StartRecieving </td> |
|
210 <td>(</td> |
|
211 <td class="paramname"> </td> |
|
212 <td> ) </td> |
|
213 <td width="100%"></td> |
|
214 </tr> |
|
215 </table> |
|
216 </div> |
|
217 <div class="memdoc"> |
|
218 |
|
219 <p> |
|
220 The following function calls the asynchronous request to recieve the words from the inverter. |
|
221 <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> |
|
222 |
|
223 </div> |
|
224 </div><p> |
|
225 <a class="anchor" name="d22077e2d9c23fb39e4073ccacd1ee89"></a><!-- doxytag: member="CCollector::SendMsgInQ" ref="d22077e2d9c23fb39e4073ccacd1ee89" args="(TBuf< 100 >)" --> |
|
226 <div class="memitem"> |
|
227 <div class="memproto"> |
|
228 <table class="memname"> |
|
229 <tr> |
|
230 <td class="memname">void CCollector::SendMsgInQ </td> |
|
231 <td>(</td> |
|
232 <td class="paramtype">TBuf< 100 > </td> |
|
233 <td class="paramname"> <em>buf</em> </td> |
|
234 <td> ) </td> |
|
235 <td width="100%"></td> |
|
236 </tr> |
|
237 </table> |
|
238 </div> |
|
239 <div class="memdoc"> |
|
240 |
|
241 <p> |
|
242 The following function sends the message to InverterInQ. |
|
243 <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> |
|
244 |
|
245 </div> |
|
246 </div><p> |
|
247 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by |
|
248 <a href="http://www.doxygen.org/index.html"> |
|
249 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
250 </body> |
|
251 </html> |