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: CQueue 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>CQueue Class Reference</h1><!-- doxytag: class="CQueue" -->
<p><a href="class_c_queue-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#acf8845b17955c6cf4e6b779630aa7f50">Insert</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#ab95dcac0beafcc90e1d2cdad2edfb35d">Remove</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#ab2c462ec968532861415e05e5f10b873">IsEmpty</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#a543c0e6f1fdcb5ff5382f50020e7c425">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_queue.html#ab4d7758aee550b3f77a800959979e9fd">GetTokens</a> (RArray< TInt > &aArray)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_queue.html#a73412173b1f7427ccd1b993acf5fb66c">~CQueue</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" 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#a2c3c0bae6b0e6aaa10df8fb51dfb7e30">NewL</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>RCondVar. </dd>
<dd>
RMutex. </dd></dl>
<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>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a73412173b1f7427ccd1b993acf5fb66c"></a><!-- doxytag: member="CQueue::~CQueue" ref="a73412173b1f7427ccd1b993acf5fb66c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CQueue::~CQueue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<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>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acf8845b17955c6cf4e6b779630aa7f50"></a><!-- doxytag: member="CQueue::Insert" ref="acf8845b17955c6cf4e6b779630aa7f50" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CQueue::Insert </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inserts a token into the queue. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>RCondVar::Signal(). </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="ab95dcac0beafcc90e1d2cdad2edfb35d"></a><!-- doxytag: member="CQueue::Remove" ref="ab95dcac0beafcc90e1d2cdad2edfb35d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CQueue::Remove </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a token from the queue. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>RCondVar::Wait(). </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="ab2c462ec968532861415e05e5f10b873"></a><!-- doxytag: member="CQueue::IsEmpty" ref="ab2c462ec968532861415e05e5f10b873" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CQueue::IsEmpty </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if the queue has at least one element. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>ETrue If the number of elements in the queue is greater than one, else EFalse. </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="a543c0e6f1fdcb5ff5382f50020e7c425"></a><!-- doxytag: member="CQueue::ConstructL" ref="a543c0e6f1fdcb5ff5382f50020e7c425" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CQueue::ConstructL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The second phase constructor of the <a class="el" href="class_c_queue.html">CQueue</a> class. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>RCondVar::CreateLocal(). </dd>
<dd>
RMutex::CreateLocal(). </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="a2c3c0bae6b0e6aaa10df8fb51dfb7e30"></a><!-- doxytag: member="CQueue::NewL" ref="a2c3c0bae6b0e6aaa10df8fb51dfb7e30" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_queue.html">CQueue</a> * CQueue::NewL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Performs the two-phase construction of an object of the <a class="el" href="class_c_queue.html">CQueue</a> class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_queue.html">CQueue</a> object. </dd></dl>
<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>
</div>
</div>
<a class="anchor" id="ab4d7758aee550b3f77a800959979e9fd"></a><!-- doxytag: member="CQueue::GetTokens" ref="ab4d7758aee550b3f77a800959979e9fd" args="(RArray< TInt > &aArray)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CQueue::GetTokens </td>
<td>(</td>
<td class="paramtype">RArray< TInt > & </td>
<td class="paramname"> <em>aArray</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs an array of elements present in the CQueue::iArray queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aArray</em> </td><td>A reference to the array to be constructed. </td></tr>
</table>
</dd>
</dl>
<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>
</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>