Class TPtrHashMapIter

class TPtrHashMapIter : public THashTableIterBase;

Description

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.

Derivation

• THashTableIterBase - No description.

• TPtrHashMapIter - A templated class which allows iteration over the elements of a RPtrHashMap class

Members

Defined in TPtrHashMapIter:
CurrentKey(), CurrentValue(), NextKey(), NextValue(), RemoveCurrent(), Reset(), TPtrHashMapIter()

inline TPtrHashMapIter(const RPtrHashMap< K, V > &aMap);

Description

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.

inline void Reset();

Description

Reset the iterator to its initial state.

inline const K *CurrentKey() const;

Description

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

Return value

const K * A pointer to the key object 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.

inline const K *NextKey();

Description

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

Return value

const K * A pointer to the key object corresponding to the next position of the iterator. NULL if the iterator has exhausted all the available key-value pairs.

inline const V *CurrentValue() const;

Description

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

Return value

const V * A pointer to the value object 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.

inline const V *NextValue();

Description

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

Return value

const V * A pointer to the value object corresponding to the next position of the iterator. NULL if the iterator has exhausted all the available key-value pairs.

inline void RemoveCurrent();

Description

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().