CrystalSpace

Public API Reference

csHash< T, K, ArrayMemoryAlloc, ArrayElementHandler >::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 ()
 Get the next element's value, don't move the iterator.
T & NextNoAdvance (K &key)
 Get the next element's value and key, 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.

Friends

class csHash< T, K, ArrayMemoryAlloc, ArrayElementHandler >

Detailed Description

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

An iterator class for the hash.

Definition at line 730 of file hash.h.


Constructor & Destructor Documentation

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

Copy constructor.

Definition at line 771 of file hash.h.


Member Function Documentation

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

Advance the iterator of one step.

Definition at line 795 of file hash.h.

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

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

Definition at line 788 of file hash.h.

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

Get the next element's value.

Definition at line 808 of file hash.h.

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

Get the next element's value and key.

Definition at line 823 of file hash.h.

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

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

Definition at line 802 of file hash.h.

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

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

Definition at line 816 of file hash.h.

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

Return a tuple of the value and key.

Definition at line 830 of file hash.h.

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

Assignment operator.

Definition at line 778 of file hash.h.

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

Move the iterator back to the first element.

Definition at line 839 of file hash.h.


The documentation for this class was generated from the following file:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1