CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

csHash< T, K, KeyHandler >::GlobalIterator Class Reference

An iterator class for the hash. More...

#include <csutil/hash.h>

Inheritance diagram for csHash< T, K, KeyHandler >::GlobalIterator:

csSet< T, KeyHandler >::GlobalIterator List of all members.

Public Member Functions

 GlobalIterator (const Iterator &o)
 Copy constructor.
GlobalIteratoroperator= (const GlobalIterator &o)
 Assignment operator.
bool HasNext () const
 Returns a boolean indicating whether or not the hash has more elements.
void Advance ()
 Advance the iterator of one step.
const T & NextNoAdvance ()
 Get the next element's value, don't move the iterator.
const T & Next ()
 Get the next element's value.
const T & Next (K &key)
 Get the next element's value and key.
void Reset ()
 Move the iterator back to the first element.

Detailed Description

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
class csHash< T, K, KeyHandler >::GlobalIterator

An iterator class for the hash.

Definition at line 442 of file hash.h.


Constructor & Destructor Documentation

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
csHash< T, K, KeyHandler >::GlobalIterator::GlobalIterator const Iterator o  )  [inline]
 

Copy constructor.

Definition at line 478 of file hash.h.


Member Function Documentation

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
void csHash< T, K, KeyHandler >::GlobalIterator::Advance  )  [inline]
 

Advance the iterator of one step.

Definition at line 502 of file hash.h.

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
bool csHash< T, K, KeyHandler >::GlobalIterator::HasNext  )  const [inline]
 

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

Definition at line 495 of file hash.h.

References csHash< T, K, KeyHandler >::Elements, and csArray< T, ElementHandler, MemoryAllocator >::Length().

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
const T& csHash< T, K, KeyHandler >::GlobalIterator::Next K &  key  )  [inline]
 

Get the next element's value and key.

Definition at line 529 of file hash.h.

References csHash< T, K, KeyHandler >::Elements.

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
const T& csHash< T, K, KeyHandler >::GlobalIterator::Next  )  [inline]
 

Get the next element's value.

Definition at line 515 of file hash.h.

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
const T& csHash< T, K, KeyHandler >::GlobalIterator::NextNoAdvance  )  [inline]
 

Get the next element's value, don't move the iterator.

Definition at line 509 of file hash.h.

References csHash< T, K, KeyHandler >::Elements.

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
GlobalIterator& csHash< T, K, KeyHandler >::GlobalIterator::operator= const GlobalIterator o  )  [inline]
 

Assignment operator.

Definition at line 485 of file hash.h.

References csHash< T, K, KeyHandler >::GlobalIterator::bucket, csHash< T, K, KeyHandler >::GlobalIterator::element, csHash< T, K, KeyHandler >::GlobalIterator::hash, and csHash< T, K, KeyHandler >::GlobalIterator::size.

template<class T, class K = unsigned int, class KeyHandler = csIntegralHashKeyHandler<K>>
void csHash< T, K, KeyHandler >::GlobalIterator::Reset  )  [inline]
 

Move the iterator back to the first element.

Definition at line 536 of file hash.h.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1