<!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 >::ConstGlobalIterator 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_1ConstGlobalIterator.html">ConstGlobalIterator</a></div> <h1>csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator Class Reference</h1><!-- doxytag: class="csHash::ConstGlobalIterator" -->An const 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_1ConstGlobalIterator-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_1ConstGlobalIterator.html#3f2ecc2196fbff8a959461a8ce9edc67">Advance</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator of one step. <a href="#3f2ecc2196fbff8a959461a8ce9edc67"></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_1ConstGlobalIterator.html#30d1acc653933f1f8304774d0f4ea545">ConstGlobalIterator</a> (const <a class="el" href="classcsHash_1_1ConstGlobalIterator.html">ConstGlobalIterator</a> &o)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#30d1acc653933f1f8304774d0f4ea545"></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_1ConstGlobalIterator.html#8fde9c33defeccec5a967951f3ba4e43">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="#8fde9c33defeccec5a967951f3ba4e43"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstGlobalIterator.html#ac1736e2487117b7a5e019a9c4eeb0c2">Next</a> (K &key)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next element's value and key. <a href="#ac1736e2487117b7a5e019a9c4eeb0c2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstGlobalIterator.html#9b0aa0b39c1903ead266d9d69c069f3a">Next</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next element's value. <a href="#9b0aa0b39c1903ead266d9d69c069f3a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstGlobalIterator.html#28e291bfd8c6fd3629794a26703a7c64">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="#28e291bfd8c6fd3629794a26703a7c64"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstGlobalIterator.html#1f48c0e4bd0a9144946fe9bc9345351f">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="#1f48c0e4bd0a9144946fe9bc9345351f"></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_1ConstGlobalIterator.html#97442a5a04b41335bf097e139f7707df">NextTuple</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a tuple of the value and key. <a href="#97442a5a04b41335bf097e139f7707df"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsHash_1_1ConstGlobalIterator.html">ConstGlobalIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstGlobalIterator.html#8712f94ade2834072035fdb413ad3a55">operator=</a> (const <a class="el" href="classcsHash_1_1ConstGlobalIterator.html">ConstGlobalIterator</a> &o)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#8712f94ade2834072035fdb413ad3a55"></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_1ConstGlobalIterator.html#06e532864f70fa0325633bcb036f3c84">Reset</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Move the iterator back to the first element. <a href="#06e532864f70fa0325633bcb036f3c84"></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="7ab04eaa35b89b00279f51c11705ffcf"></a><!-- doxytag: member="csHash::ConstGlobalIterator::ConstGlobalIterator" ref="7ab04eaa35b89b00279f51c11705ffcf" args="(const csHash< T, K > *hash0)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstGlobalIterator.html#7ab04eaa35b89b00279f51c11705ffcf">ConstGlobalIterator</a> (const <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::ConstGlobalIterator::csHash< T, K >" ref="bac4f17a9a41bec8a2ccd12f2e624f66" args="" --> class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsHash_1_1ConstGlobalIterator.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 >::ConstGlobalIterator</h3> An const iterator class for the hash. <p>Definition at line <a class="el" href="hash_8h-source.html#l00826">826</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="30d1acc653933f1f8304774d0f4ea545"></a><!-- doxytag: member="csHash::ConstGlobalIterator::ConstGlobalIterator" ref="30d1acc653933f1f8304774d0f4ea545" args="(const ConstGlobalIterator &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 >::ConstGlobalIterator::ConstGlobalIterator </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsHash_1_1ConstGlobalIterator.html">ConstGlobalIterator</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#l00866">866</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="3f2ecc2196fbff8a959461a8ce9edc67"></a><!-- doxytag: member="csHash::ConstGlobalIterator::Advance" ref="3f2ecc2196fbff8a959461a8ce9edc67" 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 >::ConstGlobalIterator::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#l00890">890</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#l00903">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::Next()</a>, and <a class="el" href="hash_8h-source.html#l00925">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::NextTuple()</a>.</p> </div> </div><p> <a class="anchor" name="8fde9c33defeccec5a967951f3ba4e43"></a><!-- doxytag: member="csHash::ConstGlobalIterator::HasNext" ref="8fde9c33defeccec5a967951f3ba4e43" 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 >::ConstGlobalIterator::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#l00883">883</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> <p>Referenced by <a class="el" href="set_8h-source.html#l00064">csSet< T, Allocator >::GlobalIterator::HasNext()</a>.</p> </div> </div><p> <a class="anchor" name="ac1736e2487117b7a5e019a9c4eeb0c2"></a><!-- doxytag: member="csHash::ConstGlobalIterator::Next" ref="ac1736e2487117b7a5e019a9c4eeb0c2" 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">const T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::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#l00918">918</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#l00903">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::Next()</a>.</p> </div> </div><p> <a class="anchor" name="9b0aa0b39c1903ead266d9d69c069f3a"></a><!-- doxytag: member="csHash::ConstGlobalIterator::Next" ref="9b0aa0b39c1903ead266d9d69c069f3a" 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 T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::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#l00903">903</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#l00890">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::Advance()</a>, and <a class="el" href="hash_8h-source.html#l00897">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::NextNoAdvance()</a>.</p> <p>Referenced by <a class="el" href="set_8h-source.html#l00068">csSet< T, Allocator >::GlobalIterator::Next()</a>, and <a class="el" href="hash_8h-source.html#l00918">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::Next()</a>.</p> </div> </div><p> <a class="anchor" name="28e291bfd8c6fd3629794a26703a7c64"></a><!-- doxytag: member="csHash::ConstGlobalIterator::NextNoAdvance" ref="28e291bfd8c6fd3629794a26703a7c64" 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">const T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::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#l00911">911</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#l00897">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::NextNoAdvance()</a>.</p> </div> </div><p> <a class="anchor" name="1f48c0e4bd0a9144946fe9bc9345351f"></a><!-- doxytag: member="csHash::ConstGlobalIterator::NextNoAdvance" ref="1f48c0e4bd0a9144946fe9bc9345351f" 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 T& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::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#l00897">897</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#l00903">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::Next()</a>, <a class="el" href="hash_8h-source.html#l00911">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::NextNoAdvance()</a>, and <a class="el" href="hash_8h-source.html#l00925">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::NextTuple()</a>.</p> </div> </div><p> <a class="anchor" name="97442a5a04b41335bf097e139f7707df"></a><!-- doxytag: member="csHash::ConstGlobalIterator::NextTuple" ref="97442a5a04b41335bf097e139f7707df" 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 >::ConstGlobalIterator::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#l00925">925</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#l00890">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::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#l00897">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::NextNoAdvance()</a>.</p> </div> </div><p> <a class="anchor" name="8712f94ade2834072035fdb413ad3a55"></a><!-- doxytag: member="csHash::ConstGlobalIterator::operator=" ref="8712f94ade2834072035fdb413ad3a55" args="(const ConstGlobalIterator &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_1ConstGlobalIterator.html">ConstGlobalIterator</a>& <a class="el" href="classcsHash.html">csHash</a>< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsHash_1_1ConstGlobalIterator.html">ConstGlobalIterator</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#l00873">873</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#l00830">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::bucket</a>, <a class="el" href="hash_8h-source.html#l00830">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::element</a>, <a class="el" href="hash_8h-source.html#l00829">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::hash</a>, and <a class="el" href="hash_8h-source.html#l00830">csHash< T, K, ArrayMemoryAlloc >::ConstGlobalIterator::size</a>.</p> </div> </div><p> <a class="anchor" name="06e532864f70fa0325633bcb036f3c84"></a><!-- doxytag: member="csHash::ConstGlobalIterator::Reset" ref="06e532864f70fa0325633bcb036f3c84" 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 >::ConstGlobalIterator::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#l00934">934</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>