Collapse all Symbian^3 Application Developer Library

TPtrHashMapIter Class Reference

class TPtrHashMapIter : public THashTableIterBase

A templated class which allows iteration over the elements of a RPtrHashMap<K,V> class.

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

RPtrHashMap<K,V>

Inherits from

TPtrHashMapIter
- THashTableIterBase

Nested Classes and Structures

TPtrHashMapIter::SFullElement

Public Member Functions
	TPtrHashMapIter (const RPtrHashMap < K, V > &)
const K *	CurrentKey ()
const V *	CurrentValue ()
const K *	NextKey ()
const V *	NextValue ()
void	RemoveCurrent ()
void	Reset ()

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

Constructor & Destructor Documentation

TPtrHashMapIter(const RPtrHashMap< K, V > &)

TPtrHashMapIter

(

const RPtrHashMap < K, V > &

aMap

)

[inline]

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

Parameters

const RPtrHashMap < K, V > & aMap

The array to be iterated over.

Member Functions Documentation

CurrentKey()

const K *

CurrentKey

(

)

const [inline]

Return the key corresponding to the current position of the iterator.

CurrentValue()

const V *

CurrentValue

(

)

const [inline]

Return the value corresponding to the current position of the iterator.

NextKey()

const K *

NextKey

(

)

[inline]

Steps the iterator to the next position and returns the corresponding key.

NextValue()

const V *

NextValue

(

)

[inline]

Steps the iterator to the next position and returns the corresponding value.

RemoveCurrent()

void

RemoveCurrent

(

)

[inline]

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 either CurrentKey() or CurrentValue() on the iterator after calling Remove() - the only legal operations are Reset() , NextKey() or NextValue() .

Reset()

void

Reset

(

)

[inline]

Reset the iterator to its initial state.