Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 650

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="classcsHash.html">csHash</a>::<a class="el" href="classcsHash_1_1ConstIterator.html">ConstIterator</a></div>
<h1>csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator Class Reference</h1><!-- doxytag: class="csHash::ConstIterator" -->An const iterator class for the hash.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="hash_8h-source.html">csutil/hash.h</a>&gt;</code>
<p>

<p>
<a href="classcsHash_1_1ConstIterator-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstIterator.html#859a534bcb0f3b6777d8a5edd596f393">ConstIterator</a> (const <a class="el" href="classcsHash_1_1ConstIterator.html">ConstIterator</a> &amp;o)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#859a534bcb0f3b6777d8a5edd596f393"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstIterator.html#ace64b256ad94c42a3cddeede9ac4f7f">HasNext</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a boolean indicating whether or not the hash has more elements.  <a href="#ace64b256ad94c42a3cddeede9ac4f7f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstIterator.html#655b9a235acdf433602c6a3c826aff5e">Next</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the next element's value.  <a href="#655b9a235acdf433602c6a3c826aff5e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsHash_1_1ConstIterator.html">ConstIterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstIterator.html#0717e8eb5d95f8c8c8df739a20c2936b">operator=</a> (const <a class="el" href="classcsHash_1_1ConstIterator.html">ConstIterator</a> &amp;o)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator.  <a href="#0717e8eb5d95f8c8c8df739a20c2936b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstIterator.html#ddb83543e460d533db84b08d5b8ba007">Reset</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the iterator back to the first element.  <a href="#ddb83543e460d533db84b08d5b8ba007"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="efce995a2cb758f0f6c1afd873c14551"></a><!-- doxytag: member="csHash::ConstIterator::ConstIterator" ref="efce995a2cb758f0f6c1afd873c14551" args="(const csHash&lt; T, K &gt; *hash0, const K &amp;key0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstIterator.html#efce995a2cb758f0f6c1afd873c14551">ConstIterator</a> (const <a class="el" href="classcsHash.html">csHash</a>&lt; T, K &gt; *hash0, const K &amp;key0)</td></tr>

<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bac4f17a9a41bec8a2ccd12f2e624f66"></a><!-- doxytag: member="csHash::ConstIterator::csHash&lt; T, K &gt;" ref="bac4f17a9a41bec8a2ccd12f2e624f66" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstIterator.html#bac4f17a9a41bec8a2ccd12f2e624f66">csHash&lt; T, K &gt;</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc&gt;<br>
 class csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator</h3>

An const iterator class for the hash. 
<p>Definition at line <a class="el" href="hash_8h-source.html#l00761">761</a> of file <a class="el" href="hash_8h-source.html">hash.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="859a534bcb0f3b6777d8a5edd596f393"></a><!-- doxytag: member="csHash::ConstIterator::ConstIterator" ref="859a534bcb0f3b6777d8a5edd596f393" args="(const ConstIterator &amp;o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsHash.html">csHash</a>&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::ConstIterator           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsHash_1_1ConstIterator.html">ConstIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Copy constructor. 
<p>

<p>Definition at line <a class="el" href="hash_8h-source.html#l00787">787</a> of file <a class="el" href="hash_8h-source.html">hash.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ace64b256ad94c42a3cddeede9ac4f7f"></a><!-- doxytag: member="csHash::ConstIterator::HasNext" ref="ace64b256ad94c42a3cddeede9ac4f7f" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classcsHash.html">csHash</a>&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::HasNext           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns a boolean indicating whether or not the hash has more elements. 
<p>

<p>Definition at line <a class="el" href="hash_8h-source.html#l00806">806</a> of file <a class="el" href="hash_8h-source.html">hash.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="655b9a235acdf433602c6a3c826aff5e"></a><!-- doxytag: member="csHash::ConstIterator::Next" ref="655b9a235acdf433602c6a3c826aff5e" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T&amp; <a class="el" href="classcsHash.html">csHash</a>&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::Next           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the next element's value. 
<p>

<p>Definition at line <a class="el" href="hash_8h-source.html#l00812">812</a> of file <a class="el" href="hash_8h-source.html">hash.h</a>.</p>

<p>References <a class="el" href="hash_8h-source.html#l00265">csHash&lt; T, K, ArrayMemoryAlloc &gt;::Elements</a>.</p>

</div>
</div><p>
<a class="anchor" name="0717e8eb5d95f8c8c8df739a20c2936b"></a><!-- doxytag: member="csHash::ConstIterator::operator=" ref="0717e8eb5d95f8c8c8df739a20c2936b" args="(const ConstIterator &amp;o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsHash_1_1ConstIterator.html">ConstIterator</a>&amp; <a class="el" href="classcsHash.html">csHash</a>&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::operator=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsHash_1_1ConstIterator.html">ConstIterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assignment operator. 
<p>

<p>Definition at line <a class="el" href="hash_8h-source.html#l00795">795</a> of file <a class="el" href="hash_8h-source.html">hash.h</a>.</p>

<p>References <a class="el" href="hash_8h-source.html#l00766">csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::bucket</a>, <a class="el" href="hash_8h-source.html#l00766">csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::element</a>, <a class="el" href="hash_8h-source.html#l00764">csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::hash</a>, <a class="el" href="hash_8h-source.html#l00765">csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::key</a>, and <a class="el" href="hash_8h-source.html#l00766">csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::size</a>.</p>

</div>
</div><p>
<a class="anchor" name="ddb83543e460d533db84b08d5b8ba007"></a><!-- doxytag: member="csHash::ConstIterator::Reset" ref="ddb83543e460d533db84b08d5b8ba007" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classcsHash.html">csHash</a>&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::Reset           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Move the iterator back to the first element. 
<p>

<p>Definition at line <a class="el" href="hash_8h-source.html#l00821">821</a> of file <a class="el" href="hash_8h-source.html">hash.h</a>.</p>

<p>Referenced by <a class="el" href="hash_8h-source.html#l00777">csHash&lt; T, K, ArrayMemoryAlloc &gt;::ConstIterator::ConstIterator()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="hash_8h-source.html">hash.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>