Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/hashtableexample_8cpp.html
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: examples/Base/HashTableExample/hashtableexample.cpp File 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>examples/Base/HashTableExample/hashtableexample.cpp File Reference</h1>
<p>
<a href="hashtableexample_8cpp-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TUint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtableexample_8cpp.html#f116fb9d6e7d2da4bc1190cc359bacb7">MyHashFunction</a> (const TMyOwnObject &aObject)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtableexample_8cpp.html#cbe0e70da9a3bb5c887d39c02af66258">MyIdentityFunction</a> (const TMyOwnObject &aObject1, const TMyOwnObject &aObject2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtableexample_8cpp.html#842a2320b517c541434909df8fe2dbc2">FindNumberInWords</a> (const TInt &aNum, TDes &aDes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5fb473d4ee18739183215b04dcad6e12"></a><!-- doxytag: member="hashtableexample.cpp::MainL" ref="5fb473d4ee18739183215b04dcad6e12" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtableexample_8cpp.html#5fb473d4ee18739183215b04dcad6e12">MainL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f358e9c4355138f629b8c4f37310295"></a><!-- doxytag: member="hashtableexample.cpp::E32Main" ref="0f358e9c4355138f629b8c4f37310295" args="()" -->
GLDEF_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="hashtableexample_8cpp.html#0f358e9c4355138f629b8c4f37310295">E32Main</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition in file <a class="el" href="hashtableexample_8cpp-source.html">hashtableexample.cpp</a>.</p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="f116fb9d6e7d2da4bc1190cc359bacb7"></a><!-- doxytag: member="hashtableexample.cpp::MyHashFunction" ref="f116fb9d6e7d2da4bc1190cc359bacb7" args="(const TMyOwnObject &aObject)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TUint32 MyHashFunction </td>
<td>(</td>
<td class="paramtype">const TMyOwnObject & </td>
<td class="paramname"> <em>aObject</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is a simple implementation of a hash function for a compound object. It is not intended as an example of an optimum hash function implementation <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aObject</em> </td><td>Custom structure object </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Integer value of hash function for two values of a specified custom structure objects </dd></dl>
<p>Definition at line <a class="el" href="hashtableexample_8cpp-source.html#l00099">99</a> of file <a class="el" href="hashtableexample_8cpp-source.html">hashtableexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="cbe0e70da9a3bb5c887d39c02af66258"></a><!-- doxytag: member="hashtableexample.cpp::MyIdentityFunction" ref="cbe0e70da9a3bb5c887d39c02af66258" args="(const TMyOwnObject &aObject1, const TMyOwnObject &aObject2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool MyIdentityFunction </td>
<td>(</td>
<td class="paramtype">const TMyOwnObject & </td>
<td class="paramname"> <em>aObject1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TMyOwnObject & </td>
<td class="paramname"> <em>aObject2</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Custom identity function in arbitary implementation to check the identity relation between the values of two custom structure objects. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aObj1</em> </td><td>Custom structure object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aObj2</em> </td><td>Custom structure object </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Boolean value of identity function for two custom structure objects </dd></dl>
<p>Definition at line <a class="el" href="hashtableexample_8cpp-source.html#l00111">111</a> of file <a class="el" href="hashtableexample_8cpp-source.html">hashtableexample.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="842a2320b517c541434909df8fe2dbc2"></a><!-- doxytag: member="hashtableexample.cpp::FindNumberInWords" ref="842a2320b517c541434909df8fe2dbc2" args="(const TInt &aNum, TDes &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FindNumberInWords </td>
<td>(</td>
<td class="paramtype">const TInt & </td>
<td class="paramname"> <em>aNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aDes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Converts the specified number into words <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aNum</em> </td><td>Integer to convert </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>Reference to the descriptor containing the result in words </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="hashtableexample_8cpp-source.html#l00266">266</a> of file <a class="el" href="hashtableexample_8cpp-source.html">hashtableexample.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:02 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>