Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: CAdder Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>CAdder Class Reference</h1><!-- doxytag: class="CAdder" -->
<p>
<a href="class_c_adder-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#76003b0896145aa8d396f596bb8fbe31">~CAdder</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#1a7d0002967f1aa090a6beb84a433d4c">Add</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#258412cf6a78091b2b9f641dadb8e41b">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#73d41c81991e4cf7b65e3644aba926cc">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#004d5ec0fb8626310fdf85843c87ec67">StartTimer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#5d5d56b9ce85c971c2e48b575f792d9d">StopTimer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#800f42785c37c746dadd65c90b7e0dfa">ReadFunction</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a7d0002967f1aa090a6beb84a433d4c"></a><!-- doxytag: member="CAdder::Add" ref="1a7d0002967f1aa090a6beb84a433d4c" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>Add</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_adder.html">CAdder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#a703f5386236c2fa9ad3b750f521200a">NewL</a> (<a class="el" href="class_c_long_number.html">CLongNumber</a> *aNum1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_adder.html">CAdder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#c207184f306dec25c5430f2c510f5c3c">NewL</a> (CConsoleBase *aConsole)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_adder.html#6e524c7466f89ca4ab9896f5bae13f3e">AddFunction</a> (TAny *aPtr)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class stores an object of the <a class="el" href="class_c_long_number.html">CLongNumber</a> class. It has methods to calculate the sum of all digits of the number represented by the iLongNumber object.<p>
The adder class. This class creates the global chunk and periodically adds random values to it. It also creates:<ul>
<li>the global condition variable</li><li>the global mutex variable</li><li>the timer object The condition variable ensures that the value of the chunk is always less than 100. </li></ul>
<p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2inc_2adder_8h-source.html#l00031">31</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2inc_2adder_8h-source.html">adder.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="76003b0896145aa8d396f596bb8fbe31"></a><!-- doxytag: member="CAdder::~CAdder" ref="76003b0896145aa8d396f596bb8fbe31" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CAdder::~CAdder </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2src_2adder_8cpp-source.html#l00073">73</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a703f5386236c2fa9ad3b750f521200a"></a><!-- doxytag: member="CAdder::NewL" ref="a703f5386236c2fa9ad3b750f521200a" args="(CLongNumber *aNum1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_adder.html">CAdder</a> * CAdder::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_long_number.html">CLongNumber</a> * </td>
<td class="paramname"> <em>aLongNumber</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an object of the <a class="el" href="class_c_adder.html">CAdder</a> class. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aLongNumber</em> </td><td>A pointer to the object of the <a class="el" href="class_c_long_number.html">CLongNumber</a> class. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the object of the <a class="el" href="class_c_adder.html">CAdder</a> class. </dd></dl>
<p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2src_2adder_8cpp-source.html#l00030">30</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1a7d0002967f1aa090a6beb84a433d4c"></a><!-- doxytag: member="CAdder::Add" ref="1a7d0002967f1aa090a6beb84a433d4c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAdder::Add </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Performs the addition of all digits of the iLongNumber object. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The sum of all digits of the iLongNumber object.</dd></dl>
Adds a random integer value to the global chunk.
<p>Definition at line <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2src_2adder_8cpp-source.html#l00047">47</a> of file <a class="el" href="_arrays_and_lists_2linkedlist_2sgllist_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c207184f306dec25c5430f2c510f5c3c"></a><!-- doxytag: member="CAdder::NewL" ref="c207184f306dec25c5430f2c510f5c3c" args="(CConsoleBase *aConsole)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_adder.html">CAdder</a> * CAdder::NewL </td>
<td>(</td>
<td class="paramtype">CConsoleBase * </td>
<td class="paramname"> <em>aConsole</em> </td>
<td> ) </td>
<td width="100%"><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. <dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_c_adder.html">CAdder</a> object. </dd></dl>
<p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html#l00030">30</a> of file <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="258412cf6a78091b2b9f641dadb8e41b"></a><!-- doxytag: member="CAdder::RunL" ref="258412cf6a78091b2b9f641dadb8e41b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAdder::RunL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></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>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html#l00043">43</a> of file <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="73d41c81991e4cf7b65e3644aba926cc"></a><!-- doxytag: member="CAdder::DoCancel" ref="73d41c81991e4cf7b65e3644aba926cc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAdder::DoCancel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cancel any outstanding request.
<p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html#l00058">58</a> of file <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="004d5ec0fb8626310fdf85843c87ec67"></a><!-- doxytag: member="CAdder::StartTimer" ref="004d5ec0fb8626310fdf85843c87ec67" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAdder::StartTimer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Starts the timer object. <dl class="see" compact><dt><b>See also:</b></dt><dd>CPeriodic::Start(). </dd></dl>
<p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html#l00139">139</a> of file <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="5d5d56b9ce85c971c2e48b575f792d9d"></a><!-- doxytag: member="CAdder::StopTimer" ref="5d5d56b9ce85c971c2e48b575f792d9d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAdder::StopTimer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stops the timer object.
<p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html#l00148">148</a> of file <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="800f42785c37c746dadd65c90b7e0dfa"></a><!-- doxytag: member="CAdder::ReadFunction" ref="800f42785c37c746dadd65c90b7e0dfa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CAdder::ReadFunction </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Issues an outstanding request to get a keystroke from the console.
<p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html#l00126">126</a> of file <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6e524c7466f89ca4ab9896f5bae13f3e"></a><!-- doxytag: member="CAdder::AddFunction" ref="6e524c7466f89ca4ab9896f5bae13f3e" args="(TAny *aPtr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CAdder::AddFunction </td>
<td>(</td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aPtr</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The call back function for the CAdder::iPeriodic object. <dl compact><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_adder.html#6e524c7466f89ca4ab9896f5bae13f3e">AddFunction()</a>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone. </dd></dl>
<p>Definition at line <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html#l00159">159</a> of file <a class="el" href="_i_p_c_2condvar_2condvarglobal_2src_2adder_8cpp-source.html">adder.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>