Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_timer_entry.html
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: CTimerEntry 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>CTimerEntry Class Reference</h1><!-- doxytag: class="CTimerEntry" -->
<p><a href="class_c_timer_entry-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#a193d31aafb44a96b5b1e2ea6c0d57f78">~CTimerEntry</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#a0500f775214fb36077a020c8d6ec58d1">AddToQueueL</a> (TInt aInterval)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#a19f74837cbfb53d10b57b922898648d1">ArbitratorL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#a41e0ec777102f5e9317469a83ddd6b82">RemoveFromQueue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#ab03ab2f073ce345c257048d5f364cc98">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#a21a3db06e926673b3dd3f83b40bd57e2">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#a06ea9b1cc9e02c51ac544ec85cacb477">IssueRequest</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#a50d4cca6ff84c59189d437bb83007a03">PrintQue</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_timer_entry.html">CTimerEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_timer_entry.html#ae9239b3945aa446c00506024551a8268">NewL</a> (CConsoleBase *aConsole)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class has a delta queue of objects of the <a class="el" href="class_t_timer_entry.html">TTimerEntry</a> class.</p>
<p>It triggers timer events at random intervals. At each such event, either the tick count is added to the queue or an element is removed from the queue based on the number of elements present in the queue.</p>
<p>The tick count is taken as the delta value of the queue and this value is adjusted each time an object of the <a class="el" href="class_t_timer_entry.html">TTimerEntry</a> class is added to the queue.</p>
<p>It also has methods to:</p>
<ul>
<li>add elements to the delta queue</li>
<li>remove elements from the delta queue. </li>
</ul>
<p>Definition at line <a class="el" href="timerentry_8h_source.html#l00064">64</a> of file <a class="el" href="timerentry_8h_source.html">timerentry.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a193d31aafb44a96b5b1e2ea6c0d57f78"></a><!-- doxytag: member="CTimerEntry::~CTimerEntry" ref="a193d31aafb44a96b5b1e2ea6c0d57f78" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTimerEntry::~CTimerEntry </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. The <a class="el" href="class_t_timer_entry.html">TTimerEntry</a> objects were allocated memory at runtime. Iterate over the list to delete them. </p>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00245">245</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae9239b3945aa446c00506024551a8268"></a><!-- doxytag: member="CTimerEntry::NewL" ref="ae9239b3945aa446c00506024551a8268" args="(CConsoleBase *aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_timer_entry.html">CTimerEntry</a> * CTimerEntry::NewL </td>
<td>(</td>
<td class="paramtype">CConsoleBase * </td>
<td class="paramname"> <em>aConsole</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates an object of the <a class="el" href="class_c_timer_entry.html">CTimerEntry</a> class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aConsole</em> </td><td>The user console. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00029">29</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0500f775214fb36077a020c8d6ec58d1"></a><!-- doxytag: member="CTimerEntry::AddToQueueL" ref="a0500f775214fb36077a020c8d6ec58d1" args="(TInt aInterval)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CTimerEntry::AddToQueueL </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aTicks</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a tick count to the delta 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>aTicks</em> </td><td>The tick count. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>EFalse if the queue is full, else EFalse. </dd></dl>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00151">151</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a19f74837cbfb53d10b57b922898648d1"></a><!-- doxytag: member="CTimerEntry::ArbitratorL" ref="a19f74837cbfb53d10b57b922898648d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimerEntry::ArbitratorL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The arbitrator function. It either adds elements to the list or removes elements from the list based on the iOp variable. </p>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00104">104</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a41e0ec777102f5e9317469a83ddd6b82"></a><!-- doxytag: member="CTimerEntry::RemoveFromQueue" ref="a41e0ec777102f5e9317469a83ddd6b82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CTimerEntry::RemoveFromQueue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes an element from the delta queue. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>EFalse if the queue is empty, else EFalse. </dd></dl>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00199">199</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab03ab2f073ce345c257048d5f364cc98"></a><!-- doxytag: member="CTimerEntry::RunL" ref="ab03ab2f073ce345c257048d5f364cc98" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimerEntry::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles the request completion. </p>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00071">71</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a21a3db06e926673b3dd3f83b40bd57e2"></a><!-- doxytag: member="CTimerEntry::DoCancel" ref="a21a3db06e926673b3dd3f83b40bd57e2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimerEntry::DoCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel any outstanding request. </p>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00266">266</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a06ea9b1cc9e02c51ac544ec85cacb477"></a><!-- doxytag: member="CTimerEntry::IssueRequest" ref="a06ea9b1cc9e02c51ac544ec85cacb477" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimerEntry::IssueRequest </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Issues a wait request. </p>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00085">85</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a50d4cca6ff84c59189d437bb83007a03"></a><!-- doxytag: member="CTimerEntry::PrintQue" ref="a50d4cca6ff84c59189d437bb83007a03" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimerEntry::PrintQue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints the contents of the delta queue. </p>
<p>Definition at line <a class="el" href="timerentry_8cpp_source.html#l00174">174</a> of file <a class="el" href="timerentry_8cpp_source.html">timerentry.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>