Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_subtractor.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: CSubtractor 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>CSubtractor Class Reference</h1><!-- doxytag: class="CSubtractor" -->
<p><a href="class_c_subtractor-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_subtractor.html#adafc90c62c12777fc2c1670cfc65ff7e">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_subtractor.html#a8fe681f7232eb2d9a8e5d6b00d56d461">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_subtractor.html#a6641d546e8cf49ad7295cf4045d6c901">~CSubtractor</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_subtractor.html#ab5a9d2c973fb9387a6519971ddcb61c2">StartTimer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_subtractor.html#a6fccf6a6e4f1b731f1d2105ccac84484">StopTimer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_subtractor.html#a0d39bfb8170e1923541fa6efd915d206">ReadFunction</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_subtractor.html#aaea4ddea47a64945f5dcd280d9f5adcb">Subtract</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_subtractor.html">CSubtractor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_subtractor.html#a7d6002b0b8610a3241853c7fb4ef3995">NewL</a> (CConsoleBase *aConsole)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_subtractor.html#a44265608e41e7a13f8790fcd68a5589d">SubtractFunction</a> (TAny *aPtr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The subtractor class. This class opens the global chunk and periodically subtracts random values from it. The condition variable ensures that the value of the chunk is always greater than 0. </p>
<p>Definition at line <a class="el" href="subtractor_8h_source.html#l00032">32</a> of file <a class="el" href="subtractor_8h_source.html">subtractor.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6641d546e8cf49ad7295cf4045d6c901"></a><!-- doxytag: member="CSubtractor::~CSubtractor" ref="a6641d546e8cf49ad7295cf4045d6c901" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSubtractor::~CSubtractor </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="subtractor_8cpp_source.html#l00070">70</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7d6002b0b8610a3241853c7fb4ef3995"></a><!-- doxytag: member="CSubtractor::NewL" ref="a7d6002b0b8610a3241853c7fb4ef3995" args="(CConsoleBase *aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_subtractor.html">CSubtractor</a> * CSubtractor::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>Performs the two-phase construction of an object of the <a class="el" href="class_c_adder.html">CAdder</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 console object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_subtractor.html">CSubtractor</a> object. </dd></dl>
<p>Definition at line <a class="el" href="subtractor_8cpp_source.html#l00030">30</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adafc90c62c12777fc2c1670cfc65ff7e"></a><!-- doxytag: member="CSubtractor::RunL" ref="adafc90c62c12777fc2c1670cfc65ff7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSubtractor::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles the key press events from the console. It stops the active scheduler for any key press event. </p>
<p>Definition at line <a class="el" href="subtractor_8cpp_source.html#l00043">43</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8fe681f7232eb2d9a8e5d6b00d56d461"></a><!-- doxytag: member="CSubtractor::DoCancel" ref="a8fe681f7232eb2d9a8e5d6b00d56d461" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSubtractor::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="subtractor_8cpp_source.html#l00058">58</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab5a9d2c973fb9387a6519971ddcb61c2"></a><!-- doxytag: member="CSubtractor::StartTimer" ref="ab5a9d2c973fb9387a6519971ddcb61c2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSubtractor::StartTimer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts the timer object. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>CPeriodic::Start(). </dd></dl>
<p>Definition at line <a class="el" href="subtractor_8cpp_source.html#l00124">124</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6fccf6a6e4f1b731f1d2105ccac84484"></a><!-- doxytag: member="CSubtractor::StopTimer" ref="a6fccf6a6e4f1b731f1d2105ccac84484" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSubtractor::StopTimer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stops the timer object. </p>
<p>Definition at line <a class="el" href="subtractor_8cpp_source.html#l00132">132</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0d39bfb8170e1923541fa6efd915d206"></a><!-- doxytag: member="CSubtractor::ReadFunction" ref="a0d39bfb8170e1923541fa6efd915d206" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSubtractor::ReadFunction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Issues an outstanding request to get a keystroke from the console. </p>
<p>Definition at line <a class="el" href="subtractor_8cpp_source.html#l00111">111</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a44265608e41e7a13f8790fcd68a5589d"></a><!-- doxytag: member="CSubtractor::SubtractFunction" ref="a44265608e41e7a13f8790fcd68a5589d" args="(TAny *aPtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CSubtractor::SubtractFunction </td>
<td>(</td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aPtr</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The call back function for the CSubtractor::iPeriodic object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aPtr</em> </td><td>Contains the address of the object passed as an argument to the <a class="el" href="class_c_subtractor.html#a44265608e41e7a13f8790fcd68a5589d">SubtractFunction()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone. </dd></dl>
<p>Definition at line <a class="el" href="subtractor_8cpp_source.html#l00143">143</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaea4ddea47a64945f5dcd280d9f5adcb"></a><!-- doxytag: member="CSubtractor::Subtract" ref="aaea4ddea47a64945f5dcd280d9f5adcb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSubtractor::Subtract </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Subtracts a random integer value from the global chunk. </p>
<p>Definition at line <a class="el" href="subtractor_8cpp_source.html#l00156">156</a> of file <a class="el" href="subtractor_8cpp_source.html">subtractor.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>