<!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< T, K, ArrayMemoryAlloc >::GlobalIterator 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="classcsHash.html">csHash</a>::<a class="el" href="classcsHash_1_1GlobalIterator.html">GlobalIterator</a></div>
<h1>csHash< T, K, ArrayMemoryAlloc >::GlobalIterator Class Reference</h1><!-- doxytag: class="csHash::GlobalIterator" -->An iterator class for the hash.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="hash_8h-source.html">csutil/hash.h</a>></code>
<p>
<p>
<a href="classcsHash_1_1GlobalIterator-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#230496a7f6abfdfca1909c099d93c293">Advance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator of one step. <a href="#230496a7f6abfdfca1909c099d93c293"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#f93d99d3c16080f6d30bf484ba52cc70">GlobalIterator</a> (const <a class="el" href="classcsHash_1_1GlobalIterator.html">GlobalIterator</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#f93d99d3c16080f6d30bf484ba52cc70"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#e45862acea507ff84122338174c49eec">HasNext</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a boolean indicating whether or not the hash has more elements. <a href="#e45862acea507ff84122338174c49eec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#32144f2a0323ebed9a73f1da6171fd0f">Next</a> (K &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next element's value and key. <a href="#32144f2a0323ebed9a73f1da6171fd0f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#ef988640dcf3b817690d2dd38ea09af3">Next</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next element's value. <a href="#ef988640dcf3b817690d2dd38ea09af3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#bba7250accf72378ca6fd895af7b2398">NextNoAdvance</a> (K &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next element's value and key, don't move the iterator. <a href="#bba7250accf72378ca6fd895af7b2398"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#bd47bc70a761f693ba261399d514e31c">NextNoAdvance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next element's value, don't move the iterator. <a href="#bd47bc70a761f693ba261399d514e31c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsTuple2.html">csTuple2</a>< T, K > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#26f18d1f391d560abaeeac805b52151a">NextTuple</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a tuple of the value and key. <a href="#26f18d1f391d560abaeeac805b52151a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsHash_1_1GlobalIterator.html">GlobalIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#89ae88d4276faa0e175f89bb43a61600">operator=</a> (const <a class="el" href="classcsHash_1_1GlobalIterator.html">GlobalIterator</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#89ae88d4276faa0e175f89bb43a61600"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#7335bde361cdbbbd96e9404976f08d83">Reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator back to the first element. <a href="#7335bde361cdbbbd96e9404976f08d83"></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="81cac1527d7a7920273e9c308175e1d7"></a><!-- doxytag: member="csHash::GlobalIterator::GlobalIterator" ref="81cac1527d7a7920273e9c308175e1d7" args="(csHash< T, K > *hash0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#81cac1527d7a7920273e9c308175e1d7">GlobalIterator</a> (<a class="el" href="classcsHash.html">csHash</a>< T, K > *hash0)</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::GlobalIterator::csHash< T, K >" ref="bac4f17a9a41bec8a2ccd12f2e624f66" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1GlobalIterator.html#bac4f17a9a41bec8a2ccd12f2e624f66">csHash< T, K ></a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc><br>
class csHash< T, K, ArrayMemoryAlloc >::GlobalIterator</h3>
An iterator class for the hash.
<p>Definition at line <a class="el" href="hash_8h-source.html#l00648">648</a> of file <a class="el" href="hash_8h-source.html">hash.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f93d99d3c16080f6d30bf484ba52cc70"></a><!-- doxytag: member="csHash::GlobalIterator::GlobalIterator" ref="f93d99d3c16080f6d30bf484ba52cc70" args="(const GlobalIterator &o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::GlobalIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsHash_1_1GlobalIterator.html">GlobalIterator</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </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#l00688">688</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="230496a7f6abfdfca1909c099d93c293"></a><!-- doxytag: member="csHash::GlobalIterator::Advance" ref="230496a7f6abfdfca1909c099d93c293" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::Advance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Advance the iterator of one step.
<p>
<p>Definition at line <a class="el" href="hash_8h-source.html#l00712">712</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#l00725">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next()</a>, and <a class="el" href="hash_8h-source.html#l00747">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextTuple()</a>.</p>
</div>
</div><p>
<a class="anchor" name="e45862acea507ff84122338174c49eec"></a><!-- doxytag: member="csHash::GlobalIterator::HasNext" ref="e45862acea507ff84122338174c49eec" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::HasNext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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#l00705">705</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< T, K, ArrayMemoryAlloc >::Elements</a>, and <a class="el" href="csutil_2array_8h-source.html#l00535">csArray< T, ElementHandler, MemoryAllocator, CapacityHandler >::GetSize()</a>.</p>
</div>
</div><p>
<a class="anchor" name="32144f2a0323ebed9a73f1da6171fd0f"></a><!-- doxytag: member="csHash::GlobalIterator::Next" ref="32144f2a0323ebed9a73f1da6171fd0f" args="(K &key)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::Next </td>
<td>(</td>
<td class="paramtype">K & </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next element's value and key.
<p>
<p>Definition at line <a class="el" href="hash_8h-source.html#l00740">740</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< T, K, ArrayMemoryAlloc >::Elements</a>, and <a class="el" href="hash_8h-source.html#l00725">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ef988640dcf3b817690d2dd38ea09af3"></a><!-- doxytag: member="csHash::GlobalIterator::Next" ref="ef988640dcf3b817690d2dd38ea09af3" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::Next </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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#l00725">725</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#l00712">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Advance()</a>, and <a class="el" href="hash_8h-source.html#l00719">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance()</a>.</p>
<p>Referenced by <a class="el" href="hash_8h-source.html#l00740">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next()</a>.</p>
</div>
</div><p>
<a class="anchor" name="bba7250accf72378ca6fd895af7b2398"></a><!-- doxytag: member="csHash::GlobalIterator::NextNoAdvance" ref="bba7250accf72378ca6fd895af7b2398" args="(K &key)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance </td>
<td>(</td>
<td class="paramtype">K & </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next element's value and key, don't move the iterator.
<p>
<p>Definition at line <a class="el" href="hash_8h-source.html#l00733">733</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< T, K, ArrayMemoryAlloc >::Elements</a>, and <a class="el" href="hash_8h-source.html#l00719">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance()</a>.</p>
</div>
</div><p>
<a class="anchor" name="bd47bc70a761f693ba261399d514e31c"></a><!-- doxytag: member="csHash::GlobalIterator::NextNoAdvance" ref="bd47bc70a761f693ba261399d514e31c" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next element's value, don't move the iterator.
<p>
<p>Definition at line <a class="el" href="hash_8h-source.html#l00719">719</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< T, K, ArrayMemoryAlloc >::Elements</a>.</p>
<p>Referenced by <a class="el" href="hash_8h-source.html#l00725">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next()</a>, <a class="el" href="hash_8h-source.html#l00733">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance()</a>, and <a class="el" href="hash_8h-source.html#l00747">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextTuple()</a>.</p>
</div>
</div><p>
<a class="anchor" name="26f18d1f391d560abaeeac805b52151a"></a><!-- doxytag: member="csHash::GlobalIterator::NextTuple" ref="26f18d1f391d560abaeeac805b52151a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classcsTuple2.html">csTuple2</a><T, K> <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::NextTuple </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a tuple of the value and key.
<p>
<p>Definition at line <a class="el" href="hash_8h-source.html#l00747">747</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#l00712">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Advance()</a>, <a class="el" href="hash_8h-source.html#l00265">csHash< T, K, ArrayMemoryAlloc >::Elements</a>, and <a class="el" href="hash_8h-source.html#l00719">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance()</a>.</p>
</div>
</div><p>
<a class="anchor" name="89ae88d4276faa0e175f89bb43a61600"></a><!-- doxytag: member="csHash::GlobalIterator::operator=" ref="89ae88d4276faa0e175f89bb43a61600" args="(const GlobalIterator &o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsHash_1_1GlobalIterator.html">GlobalIterator</a>& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsHash_1_1GlobalIterator.html">GlobalIterator</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </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#l00695">695</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#l00652">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::bucket</a>, <a class="el" href="hash_8h-source.html#l00652">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::element</a>, <a class="el" href="hash_8h-source.html#l00651">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::hash</a>, and <a class="el" href="hash_8h-source.html#l00652">csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::size</a>.</p>
</div>
</div><p>
<a class="anchor" name="7335bde361cdbbbd96e9404976f08d83"></a><!-- doxytag: member="csHash::GlobalIterator::Reset" ref="7335bde361cdbbbd96e9404976f08d83" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::GlobalIterator::Reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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#l00756">756</a> of file <a class="el" href="hash_8h-source.html">hash.h</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
652
