CrystalSpace

Public API Reference

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

An iterator class for the hash. More...

#include <csutil/hash.h>

List of all members.

Public Member Functions

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

Protected Member Functions

 GlobalIterator (csHash< T, K > *hash0)

Friends

class csHash< T, K >


Detailed Description

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
class csHash< T, K, ArrayMemoryAlloc >::GlobalIterator

An iterator class for the hash.

Definition at line 648 of file hash.h.


Constructor & Destructor Documentation

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::GlobalIterator ( const GlobalIterator o  )  [inline]

Copy constructor.

Definition at line 688 of file hash.h.


Member Function Documentation

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
void csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Advance (  )  [inline]

Advance the iterator of one step.

Definition at line 712 of file hash.h.

Referenced by csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next(), and csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextTuple().

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
bool csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::HasNext (  )  const [inline]

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

Definition at line 705 of file hash.h.

References csHash< T, K, ArrayMemoryAlloc >::Elements, and csArray< T, ElementHandler, MemoryAllocator, CapacityHandler >::GetSize().

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
T& csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next ( K &  key  )  [inline]

Get the next element's value and key.

Definition at line 740 of file hash.h.

References csHash< T, K, ArrayMemoryAlloc >::Elements, and csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next().

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
T& csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Next (  )  [inline]

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
T& csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance ( K &  key  )  [inline]

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

Definition at line 733 of file hash.h.

References csHash< T, K, ArrayMemoryAlloc >::Elements, and csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance().

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
T& csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextNoAdvance (  )  [inline]

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
const csTuple2<T, K> csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::NextTuple (  )  [inline]

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
GlobalIterator& csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::operator= ( const GlobalIterator o  )  [inline]

template<class T, class K = unsigned int, class ArrayMemoryAlloc = CS::Memory::AllocatorMalloc>
void csHash< T, K, ArrayMemoryAlloc >::GlobalIterator::Reset (  )  [inline]

Move the iterator back to the first element.

Definition at line 756 of file hash.h.


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