|
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: CQueue 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>CQueue Class Reference</h1><!-- doxytag: class="CQueue" --> |
|
9 <p> |
|
10 <a href="class_c_queue-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_queue.html#cf8845b17955c6cf4e6b779630aa7f50">Insert</a> ()</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_queue.html#b95dcac0beafcc90e1d2cdad2edfb35d">Remove</a> ()</td></tr> |
|
16 |
|
17 <tr><td class="memItemLeft" nowrap align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#b2c462ec968532861415e05e5f10b873">IsEmpty</a> ()</td></tr> |
|
18 |
|
19 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#543c0e6f1fdcb5ff5382f50020e7c425">ConstructL</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_queue.html#b4d7758aee550b3f77a800959979e9fd">GetTokens</a> (RArray< TInt > &aArray)</td></tr> |
|
22 |
|
23 <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#73412173b1f7427ccd1b993acf5fb66c">~CQueue</a> ()</td></tr> |
|
24 |
|
25 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> |
|
26 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_queue.html">CQueue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#2c3c0bae6b0e6aaa10df8fb51dfb7e30">NewL</a> ()</td></tr> |
|
27 |
|
28 </table> |
|
29 <hr><a name="_details"></a><h2>Detailed Description</h2> |
|
30 A wrapper class that implements the queue of integer tokens. It owns a handle to an integer array. This array is treated as a queue of tokens. It provides functions to insert, delete and display elements in the queue. It also owns a handle to the condition variable and a mutex variable. <dl class="see" compact><dt><b>See also:</b></dt><dd>RCondVar. <p> |
|
31 RMutex. </dd></dl> |
|
32 |
|
33 <p>Definition at line <a class="el" href="queue_8h-source.html#l00035">35</a> of file <a class="el" href="queue_8h-source.html">queue.h</a>.</p> |
|
34 <hr><h2>Constructor & Destructor Documentation</h2> |
|
35 <a class="anchor" name="73412173b1f7427ccd1b993acf5fb66c"></a><!-- doxytag: member="CQueue::~CQueue" ref="73412173b1f7427ccd1b993acf5fb66c" args="()" --> |
|
36 <div class="memitem"> |
|
37 <div class="memproto"> |
|
38 <table class="memname"> |
|
39 <tr> |
|
40 <td class="memname">CQueue::~CQueue </td> |
|
41 <td>(</td> |
|
42 <td class="paramname"> </td> |
|
43 <td> ) </td> |
|
44 <td width="100%"></td> |
|
45 </tr> |
|
46 </table> |
|
47 </div> |
|
48 <div class="memdoc"> |
|
49 |
|
50 <p> |
|
51 Destructor. |
|
52 <p>Definition at line <a class="el" href="queue_8cpp-source.html#l00140">140</a> of file <a class="el" href="queue_8cpp-source.html">queue.cpp</a>.</p> |
|
53 |
|
54 </div> |
|
55 </div><p> |
|
56 <hr><h2>Member Function Documentation</h2> |
|
57 <a class="anchor" name="cf8845b17955c6cf4e6b779630aa7f50"></a><!-- doxytag: member="CQueue::Insert" ref="cf8845b17955c6cf4e6b779630aa7f50" args="()" --> |
|
58 <div class="memitem"> |
|
59 <div class="memproto"> |
|
60 <table class="memname"> |
|
61 <tr> |
|
62 <td class="memname">void CQueue::Insert </td> |
|
63 <td>(</td> |
|
64 <td class="paramname"> </td> |
|
65 <td> ) </td> |
|
66 <td width="100%"></td> |
|
67 </tr> |
|
68 </table> |
|
69 </div> |
|
70 <div class="memdoc"> |
|
71 |
|
72 <p> |
|
73 Inserts a token into the queue. <dl class="see" compact><dt><b>See also:</b></dt><dd>RCondVar::Signal(). </dd></dl> |
|
74 |
|
75 <p>Definition at line <a class="el" href="queue_8cpp-source.html#l00062">62</a> of file <a class="el" href="queue_8cpp-source.html">queue.cpp</a>.</p> |
|
76 |
|
77 </div> |
|
78 </div><p> |
|
79 <a class="anchor" name="b95dcac0beafcc90e1d2cdad2edfb35d"></a><!-- doxytag: member="CQueue::Remove" ref="b95dcac0beafcc90e1d2cdad2edfb35d" args="()" --> |
|
80 <div class="memitem"> |
|
81 <div class="memproto"> |
|
82 <table class="memname"> |
|
83 <tr> |
|
84 <td class="memname">void CQueue::Remove </td> |
|
85 <td>(</td> |
|
86 <td class="paramname"> </td> |
|
87 <td> ) </td> |
|
88 <td width="100%"></td> |
|
89 </tr> |
|
90 </table> |
|
91 </div> |
|
92 <div class="memdoc"> |
|
93 |
|
94 <p> |
|
95 Removes a token from the queue. <dl class="see" compact><dt><b>See also:</b></dt><dd>RCondVar::Wait(). </dd></dl> |
|
96 |
|
97 <p>Definition at line <a class="el" href="queue_8cpp-source.html#l00090">90</a> of file <a class="el" href="queue_8cpp-source.html">queue.cpp</a>.</p> |
|
98 |
|
99 </div> |
|
100 </div><p> |
|
101 <a class="anchor" name="b2c462ec968532861415e05e5f10b873"></a><!-- doxytag: member="CQueue::IsEmpty" ref="b2c462ec968532861415e05e5f10b873" args="()" --> |
|
102 <div class="memitem"> |
|
103 <div class="memproto"> |
|
104 <table class="memname"> |
|
105 <tr> |
|
106 <td class="memname">TBool CQueue::IsEmpty </td> |
|
107 <td>(</td> |
|
108 <td class="paramname"> </td> |
|
109 <td> ) </td> |
|
110 <td width="100%"></td> |
|
111 </tr> |
|
112 </table> |
|
113 </div> |
|
114 <div class="memdoc"> |
|
115 |
|
116 <p> |
|
117 Checks if the queue has at least one element. <dl class="return" compact><dt><b>Returns:</b></dt><dd>ETrue If the number of elements in the queue is greater than one, else EFalse. </dd></dl> |
|
118 |
|
119 <p>Definition at line <a class="el" href="queue_8cpp-source.html#l00116">116</a> of file <a class="el" href="queue_8cpp-source.html">queue.cpp</a>.</p> |
|
120 |
|
121 </div> |
|
122 </div><p> |
|
123 <a class="anchor" name="543c0e6f1fdcb5ff5382f50020e7c425"></a><!-- doxytag: member="CQueue::ConstructL" ref="543c0e6f1fdcb5ff5382f50020e7c425" args="()" --> |
|
124 <div class="memitem"> |
|
125 <div class="memproto"> |
|
126 <table class="memname"> |
|
127 <tr> |
|
128 <td class="memname">void CQueue::ConstructL </td> |
|
129 <td>(</td> |
|
130 <td class="paramname"> </td> |
|
131 <td> ) </td> |
|
132 <td width="100%"></td> |
|
133 </tr> |
|
134 </table> |
|
135 </div> |
|
136 <div class="memdoc"> |
|
137 |
|
138 <p> |
|
139 The second phase constructor of the <a class="el" href="class_c_queue.html">CQueue</a> class. <dl class="see" compact><dt><b>See also:</b></dt><dd>RCondVar::CreateLocal(). <p> |
|
140 RMutex::CreateLocal(). </dd></dl> |
|
141 |
|
142 <p>Definition at line <a class="el" href="queue_8cpp-source.html#l00043">43</a> of file <a class="el" href="queue_8cpp-source.html">queue.cpp</a>.</p> |
|
143 |
|
144 </div> |
|
145 </div><p> |
|
146 <a class="anchor" name="2c3c0bae6b0e6aaa10df8fb51dfb7e30"></a><!-- doxytag: member="CQueue::NewL" ref="2c3c0bae6b0e6aaa10df8fb51dfb7e30" args="()" --> |
|
147 <div class="memitem"> |
|
148 <div class="memproto"> |
|
149 <table class="memname"> |
|
150 <tr> |
|
151 <td class="memname"><a class="el" href="class_c_queue.html">CQueue</a> * CQueue::NewL </td> |
|
152 <td>(</td> |
|
153 <td class="paramname"> </td> |
|
154 <td> ) </td> |
|
155 <td width="100%"><code> [static]</code></td> |
|
156 </tr> |
|
157 </table> |
|
158 </div> |
|
159 <div class="memdoc"> |
|
160 |
|
161 <p> |
|
162 Performs the two-phase construction of an object of the <a class="el" href="class_c_queue.html">CQueue</a> class. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_queue.html">CQueue</a> object. </dd></dl> |
|
163 |
|
164 <p>Definition at line <a class="el" href="queue_8cpp-source.html#l00029">29</a> of file <a class="el" href="queue_8cpp-source.html">queue.cpp</a>.</p> |
|
165 |
|
166 </div> |
|
167 </div><p> |
|
168 <a class="anchor" name="b4d7758aee550b3f77a800959979e9fd"></a><!-- doxytag: member="CQueue::GetTokens" ref="b4d7758aee550b3f77a800959979e9fd" args="(RArray< TInt > &aArray)" --> |
|
169 <div class="memitem"> |
|
170 <div class="memproto"> |
|
171 <table class="memname"> |
|
172 <tr> |
|
173 <td class="memname">void CQueue::GetTokens </td> |
|
174 <td>(</td> |
|
175 <td class="paramtype">RArray< TInt > & </td> |
|
176 <td class="paramname"> <em>aArray</em> </td> |
|
177 <td> ) </td> |
|
178 <td width="100%"></td> |
|
179 </tr> |
|
180 </table> |
|
181 </div> |
|
182 <div class="memdoc"> |
|
183 |
|
184 <p> |
|
185 Constructs an array of elements present in the CQueue::iArray queue. <dl compact><dt><b>Parameters:</b></dt><dd> |
|
186 <table border="0" cellspacing="2" cellpadding="0"> |
|
187 <tr><td valign="top"></td><td valign="top"><em>aArray</em> </td><td>A reference to the array to be constructed. </td></tr> |
|
188 </table> |
|
189 </dl> |
|
190 |
|
191 <p>Definition at line <a class="el" href="queue_8cpp-source.html#l00129">129</a> of file <a class="el" href="queue_8cpp-source.html">queue.cpp</a>.</p> |
|
192 |
|
193 </div> |
|
194 </div><p> |
|
195 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by |
|
196 <a href="http://www.doxygen.org/index.html"> |
|
197 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
|
198 </body> |
|
199 </html> |