|
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: CUserInterface 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>CUserInterface Class Reference</h1><!-- doxytag: class="CUserInterface" --> |
|
9 <p> |
|
10 <a href="class_c_user_interface-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#a8a0207b3e2e8fa75dc320249bc55439">Initialize</a> (CConsoleBase *aConsole, <a class="el" href="class_c_timer_entry.html">CTimerEntry</a> *aTimerEntry)</td></tr> |
|
14 |
|
15 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#8c143ef7ca363188ea135090f5de77b5">RunL</a> ()</td></tr> |
|
16 |
|
17 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#e05bc833da45def9d5f78b766bd36fc4">DoCancel</a> ()</td></tr> |
|
18 |
|
19 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#e5fc74a4d70f9a30f027aa56cd3827d2">~CUserInterface</a> ()</td></tr> |
|
20 |
|
21 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#9f9158c56f74b7c8da6c527f346c9952">ReadFunc</a> ()</td></tr> |
|
22 |
|
23 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#3f4f73849ca681db69f9c5cf546de0c2">Initialize</a> (CConsoleBase *aConsole, <a class="el" href="class_c_producer.html">CProducer</a> *aProducer)</td></tr> |
|
24 |
|
25 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c143ef7ca363188ea135090f5de77b5"></a><!-- doxytag: member="CUserInterface::RunL" ref="8c143ef7ca363188ea135090f5de77b5" args="()" --> |
|
26 void </td><td class="memItemRight" valign="bottom"><b>RunL</b> ()</td></tr> |
|
27 |
|
28 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e05bc833da45def9d5f78b766bd36fc4"></a><!-- doxytag: member="CUserInterface::DoCancel" ref="e05bc833da45def9d5f78b766bd36fc4" args="()" --> |
|
29 void </td><td class="memItemRight" valign="bottom"><b>DoCancel</b> ()</td></tr> |
|
30 |
|
31 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f9158c56f74b7c8da6c527f346c9952"></a><!-- doxytag: member="CUserInterface::ReadFunc" ref="9f9158c56f74b7c8da6c527f346c9952" args="()" --> |
|
32 void </td><td class="memItemRight" valign="bottom"><b>ReadFunc</b> ()</td></tr> |
|
33 |
|
34 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
|
35 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_user_interface.html">CUserInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#cb29c660858994d24137bb413fee4af8">NewL</a> (CConsoleBase *aConsole, <a class="el" href="class_c_timer_entry.html">CTimerEntry</a> *aTimerEntry)</td></tr> |
|
36 |
|
37 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_user_interface.html">CUserInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_user_interface.html#bc39d0697d4b335dc3567726ea1b2a16">NewL</a> (CConsoleBase *aConsole, <a class="el" href="class_c_producer.html">CProducer</a> *aProducer)</td></tr> |
|
38 |
|
39 </table> |
|
40 <hr><a name="_details"></a><h2>Detailed Description</h2> |
|
41 This class processes key press events from the console. The example prints a menu and waits for the user to select an option from the menu. The <a class="el" href="class_c_user_interface.html#8c143ef7ca363188ea135090f5de77b5">CUserInterface::RunL()</a> function handles the asynchronous key press event. |
|
42 <p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2inc_2userinterface_8h-source.html#l00032">32</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2inc_2userinterface_8h-source.html">userinterface.h</a>.</p> |
|
43 <hr><h2>Constructor & Destructor Documentation</h2> |
|
44 <a class="anchor" name="e5fc74a4d70f9a30f027aa56cd3827d2"></a><!-- doxytag: member="CUserInterface::~CUserInterface" ref="e5fc74a4d70f9a30f027aa56cd3827d2" args="()" --> |
|
45 <div class="memitem"> |
|
46 <div class="memproto"> |
|
47 <table class="memname"> |
|
48 <tr> |
|
49 <td class="memname">CUserInterface::~CUserInterface </td> |
|
50 <td>(</td> |
|
51 <td class="paramname"> </td> |
|
52 <td> ) </td> |
|
53 <td width="100%"></td> |
|
54 </tr> |
|
55 </table> |
|
56 </div> |
|
57 <div class="memdoc"> |
|
58 |
|
59 <p> |
|
60 Destructor. |
|
61 <p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html#l00099">99</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
62 |
|
63 </div> |
|
64 </div><p> |
|
65 <hr><h2>Member Function Documentation</h2> |
|
66 <a class="anchor" name="cb29c660858994d24137bb413fee4af8"></a><!-- doxytag: member="CUserInterface::NewL" ref="cb29c660858994d24137bb413fee4af8" args="(CConsoleBase *aConsole, CTimerEntry *aTimerEntry)" --> |
|
67 <div class="memitem"> |
|
68 <div class="memproto"> |
|
69 <table class="memname"> |
|
70 <tr> |
|
71 <td class="memname"><a class="el" href="class_c_user_interface.html">CUserInterface</a> * CUserInterface::NewL </td> |
|
72 <td>(</td> |
|
73 <td class="paramtype">CConsoleBase * </td> |
|
74 <td class="paramname"> <em>aConsole</em>, </td> |
|
75 </tr> |
|
76 <tr> |
|
77 <td class="paramkey"></td> |
|
78 <td></td> |
|
79 <td class="paramtype"><a class="el" href="class_c_timer_entry.html">CTimerEntry</a> * </td> |
|
80 <td class="paramname"> <em>aTimerEntry</em></td><td> </td> |
|
81 </tr> |
|
82 <tr> |
|
83 <td></td> |
|
84 <td>)</td> |
|
85 <td></td><td></td><td width="100%"><code> [static]</code></td> |
|
86 </tr> |
|
87 </table> |
|
88 </div> |
|
89 <div class="memdoc"> |
|
90 |
|
91 <p> |
|
92 The static function to create an object of the <a class="el" href="class_c_user_interface.html">CUserInterface</a> class. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
93 <table border="0" cellspacing="2" cellpadding="0"> |
|
94 <tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The console object. </td></tr> |
|
95 <tr><td valign="top"></td><td valign="top"><em>aTimerEntry</em> </td><td>A pointer to an object of the <a class="el" href="class_c_timer_entry.html">CTimerEntry</a> class. </td></tr> |
|
96 </table> |
|
97 </dl> |
|
98 <dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_user_interface.html">CUserInterface</a> object. </dd></dl> |
|
99 |
|
100 <p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html#l00030">30</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
101 |
|
102 </div> |
|
103 </div><p> |
|
104 <a class="anchor" name="a8a0207b3e2e8fa75dc320249bc55439"></a><!-- doxytag: member="CUserInterface::Initialize" ref="a8a0207b3e2e8fa75dc320249bc55439" args="(CConsoleBase *aConsole, CTimerEntry *aTimerEntry)" --> |
|
105 <div class="memitem"> |
|
106 <div class="memproto"> |
|
107 <table class="memname"> |
|
108 <tr> |
|
109 <td class="memname">void CUserInterface::Initialize </td> |
|
110 <td>(</td> |
|
111 <td class="paramtype">CConsoleBase * </td> |
|
112 <td class="paramname"> <em>aConsole</em>, </td> |
|
113 </tr> |
|
114 <tr> |
|
115 <td class="paramkey"></td> |
|
116 <td></td> |
|
117 <td class="paramtype"><a class="el" href="class_c_timer_entry.html">CTimerEntry</a> * </td> |
|
118 <td class="paramname"> <em>aTimerEntry</em></td><td> </td> |
|
119 </tr> |
|
120 <tr> |
|
121 <td></td> |
|
122 <td>)</td> |
|
123 <td></td><td></td><td width="100%"></td> |
|
124 </tr> |
|
125 </table> |
|
126 </div> |
|
127 <div class="memdoc"> |
|
128 |
|
129 <p> |
|
130 Initialize the data members of the <a class="el" href="class_c_user_interface.html">CUserInterface</a> class. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
131 <table border="0" cellspacing="2" cellpadding="0"> |
|
132 <tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The console object. </td></tr> |
|
133 <tr><td valign="top"></td><td valign="top"><em>aTimerEntry</em> </td><td>A pointer to an object of the <a class="el" href="class_c_timer_entry.html">CTimerEntry</a> class. </td></tr> |
|
134 </table> |
|
135 </dl> |
|
136 |
|
137 <p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html#l00042">42</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
138 |
|
139 </div> |
|
140 </div><p> |
|
141 <a class="anchor" name="8c143ef7ca363188ea135090f5de77b5"></a><!-- doxytag: member="CUserInterface::RunL" ref="8c143ef7ca363188ea135090f5de77b5" args="()" --> |
|
142 <div class="memitem"> |
|
143 <div class="memproto"> |
|
144 <table class="memname"> |
|
145 <tr> |
|
146 <td class="memname">void CUserInterface::RunL </td> |
|
147 <td>(</td> |
|
148 <td class="paramname"> </td> |
|
149 <td> ) </td> |
|
150 <td width="100%"></td> |
|
151 </tr> |
|
152 </table> |
|
153 </div> |
|
154 <div class="memdoc"> |
|
155 |
|
156 <p> |
|
157 Handles the key press events from the console. It stops the active scheduler if any key is pressed.<p> |
|
158 Handles the key press events from the console. The following actions are defined for a key press event:<ul> |
|
159 <li>Call the CPRoducer::Produce() function if 'p' is pressed</li><li>Call the CPRoducer::Display() function if 'd' is pressed</li><li>Stop the active scheduler if any other key is pressed </li></ul> |
|
160 |
|
161 <p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html#l00061">61</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
162 |
|
163 </div> |
|
164 </div><p> |
|
165 <a class="anchor" name="e05bc833da45def9d5f78b766bd36fc4"></a><!-- doxytag: member="CUserInterface::DoCancel" ref="e05bc833da45def9d5f78b766bd36fc4" args="()" --> |
|
166 <div class="memitem"> |
|
167 <div class="memproto"> |
|
168 <table class="memname"> |
|
169 <tr> |
|
170 <td class="memname">void CUserInterface::DoCancel </td> |
|
171 <td>(</td> |
|
172 <td class="paramname"> </td> |
|
173 <td> ) </td> |
|
174 <td width="100%"></td> |
|
175 </tr> |
|
176 </table> |
|
177 </div> |
|
178 <div class="memdoc"> |
|
179 |
|
180 <p> |
|
181 Cancel any outstanding request. |
|
182 <p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html#l00087">87</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
183 |
|
184 </div> |
|
185 </div><p> |
|
186 <a class="anchor" name="9f9158c56f74b7c8da6c527f346c9952"></a><!-- doxytag: member="CUserInterface::ReadFunc" ref="9f9158c56f74b7c8da6c527f346c9952" args="()" --> |
|
187 <div class="memitem"> |
|
188 <div class="memproto"> |
|
189 <table class="memname"> |
|
190 <tr> |
|
191 <td class="memname">void CUserInterface::ReadFunc </td> |
|
192 <td>(</td> |
|
193 <td class="paramname"> </td> |
|
194 <td> ) </td> |
|
195 <td width="100%"></td> |
|
196 </tr> |
|
197 </table> |
|
198 </div> |
|
199 <div class="memdoc"> |
|
200 |
|
201 <p> |
|
202 Issues an outstanding request to get a keystroke from the console. |
|
203 <p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html#l00074">74</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2deltaque_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
204 |
|
205 </div> |
|
206 </div><p> |
|
207 <a class="anchor" name="bc39d0697d4b335dc3567726ea1b2a16"></a><!-- doxytag: member="CUserInterface::NewL" ref="bc39d0697d4b335dc3567726ea1b2a16" args="(CConsoleBase *aConsole, CProducer *aProducer)" --> |
|
208 <div class="memitem"> |
|
209 <div class="memproto"> |
|
210 <table class="memname"> |
|
211 <tr> |
|
212 <td class="memname"><a class="el" href="class_c_user_interface.html">CUserInterface</a> * CUserInterface::NewL </td> |
|
213 <td>(</td> |
|
214 <td class="paramtype">CConsoleBase * </td> |
|
215 <td class="paramname"> <em>aConsole</em>, </td> |
|
216 </tr> |
|
217 <tr> |
|
218 <td class="paramkey"></td> |
|
219 <td></td> |
|
220 <td class="paramtype"><a class="el" href="class_c_producer.html">CProducer</a> * </td> |
|
221 <td class="paramname"> <em>aProducer</em></td><td> </td> |
|
222 </tr> |
|
223 <tr> |
|
224 <td></td> |
|
225 <td>)</td> |
|
226 <td></td><td></td><td width="100%"><code> [static]</code></td> |
|
227 </tr> |
|
228 </table> |
|
229 </div> |
|
230 <div class="memdoc"> |
|
231 |
|
232 <p> |
|
233 The static function to create an object of the <a class="el" href="class_c_user_interface.html">CUserInterface</a> class. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
234 <table border="0" cellspacing="2" cellpadding="0"> |
|
235 <tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The console object. </td></tr> |
|
236 <tr><td valign="top"></td><td valign="top"><em>aProducer</em> </td><td>A pointer to an object of the <a class="el" href="class_c_producer.html">CProducer</a> class. </td></tr> |
|
237 <tr><td valign="top"></td><td valign="top"><em>aConsumer</em> </td><td>A pointer to an object of the <a class="el" href="class_c_consumer.html">CConsumer</a> class. </td></tr> |
|
238 </table> |
|
239 </dl> |
|
240 <dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_user_interface.html">CUserInterface</a> object. </dd></dl> |
|
241 |
|
242 <p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarlocal_2src_2userinterface_8cpp-source.html#l00032">32</a> of file <a class="el" href="_i_p_c_2condvar_2condvarlocal_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
243 |
|
244 </div> |
|
245 </div><p> |
|
246 <a class="anchor" name="3f4f73849ca681db69f9c5cf546de0c2"></a><!-- doxytag: member="CUserInterface::Initialize" ref="3f4f73849ca681db69f9c5cf546de0c2" args="(CConsoleBase *aConsole, CProducer *aProducer)" --> |
|
247 <div class="memitem"> |
|
248 <div class="memproto"> |
|
249 <table class="memname"> |
|
250 <tr> |
|
251 <td class="memname">void CUserInterface::Initialize </td> |
|
252 <td>(</td> |
|
253 <td class="paramtype">CConsoleBase * </td> |
|
254 <td class="paramname"> <em>aConsole</em>, </td> |
|
255 </tr> |
|
256 <tr> |
|
257 <td class="paramkey"></td> |
|
258 <td></td> |
|
259 <td class="paramtype"><a class="el" href="class_c_producer.html">CProducer</a> * </td> |
|
260 <td class="paramname"> <em>aProducer</em></td><td> </td> |
|
261 </tr> |
|
262 <tr> |
|
263 <td></td> |
|
264 <td>)</td> |
|
265 <td></td><td></td><td width="100%"></td> |
|
266 </tr> |
|
267 </table> |
|
268 </div> |
|
269 <div class="memdoc"> |
|
270 |
|
271 <p> |
|
272 Initialize the data members of the <a class="el" href="class_c_user_interface.html">CUserInterface</a> class. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
273 <table border="0" cellspacing="2" cellpadding="0"> |
|
274 <tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The console object. </td></tr> |
|
275 <tr><td valign="top"></td><td valign="top"><em>aProducer</em> </td><td>A pointer to an object of the <a class="el" href="class_c_producer.html">CProducer</a> class. </td></tr> |
|
276 <tr><td valign="top"></td><td valign="top"><em>aConsumer</em> </td><td>A pointer to an object of the <a class="el" href="class_c_consumer.html">CConsumer</a> class. </td></tr> |
|
277 </table> |
|
278 </dl> |
|
279 |
|
280 <p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarlocal_2src_2userinterface_8cpp-source.html#l00045">45</a> of file <a class="el" href="_i_p_c_2condvar_2condvarlocal_2src_2userinterface_8cpp-source.html">userinterface.cpp</a>.</p> |
|
281 |
|
282 </div> |
|
283 </div><p> |
|
284 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by |
|
285 <a href="http://www.doxygen.org/index.html"> |
|
286 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
287 </body> |
|
288 </html> |