TPtrHashSetIter Class Reference

#include <e32hashtab.h>

class TPtrHashSetIter : public THashTableIterBase

Inherits from

TPtrHashSetIter
- THashTableIterBase

Public Member Functions
	TPtrHashSetIter(const RPtrHashSet< T > &)
const T *	Current()
const T *	Next()
void	RemoveCurrent()
void	Reset()

Inherited Functions
	THashTableIterBase::Current(TInt)const
	THashTableIterBase::Next(TInt)
	THashTableIterBase::THashTableIterBase(const RHashTableBase &)

Detailed Description

A templated class which allows iteration over the elements of a RPtrHashSet<T> class.

The set being iterated over may not be modified while an iteration is in progress or the iteration operations may malfunction or panic.

Constructor & Destructor Documentation

TPtrHashSetIter ( const RPtrHashSet< T > & )

TPtrHashSetIter

(

const RPtrHashSet< T > &

aSet

)

[inline]

Construct an iterator over the specified set. The iterator starts at conceptual position one before the beginning of the list being iterated.

Parameters
aSet	The set to be iterated over.

Member Function Documentation

Current ( )

const T *

Current

(

)

const [inline]

Return the current position of the iterator.

Return Value: A pointer to the set member corresponding to the current position of the iterator. NULL if the iterator has just been constructed or reset, or if it has previously reached the end of an iteration.

Next ( )

const T *

(

)

[inline]

Steps the iterator to the next position.

Return Value: A pointer to the set member corresponding to the next position of the iterator. NULL if the iterator has exhausted all the available set elements.

RemoveCurrent ( )

void

RemoveCurrent

(

)

[inline]

Reimplemented from THashTableIterBase::RemoveCurrent()

Removes the element at the current iterator position from the hash table. If the iterator does not currently point to a valid element, no action is taken. Note that the iterator position is not altered so it no longer points to a valid element following the Remove(). It is illegal to call Current() on the iterator after calling Remove() - the only legal operations are Reset() and Next().

Reset ( )

void

Reset

(

)

[inline]

Reimplemented from THashTableIterBase::Reset()

Reset the iterator to its initial state.