Click on the banner to return to the Class Reference home page.
Return to the Appendix home page.

©Copyright 1996 Rogue Wave Software

RWTValHashDictionaryIterator<K,V>

Alternate template: Standard C++ Library not required

• Synopsis
• Please Note!
• Description
• Persistence
• Public Constructor
• Public Operators
• Public Member Functions

#include <rw/tvhdict.h>

unsigned hashFun(const K&);
RWTValHashDictionary<K,V> dictionary(hashFun);
RWTValHashDictonaryIterator<K,V> iterator(dictionary);

Iterator for class RWTValHashDictionary<K,V>, allowing sequential access to all keys and values of a parameterized hash dictionary. Elements are not accessed in any particular order.

Like all Rogue Wave iterators, the "current item" is undefined immediately after construction -- you must define it by using operator() or some other (valid) operation.

Once the iterator has advanced beyond the end of the collection it is no longer valid -- continuing to use it will bring undefined results.

None

RWTValHashDictionaryIterator(RWTValHashDictionary& c);

Constructs an iterator to be used with the dictionary c.

RWBoolean
operator++();

Advances the iterator one position. Returns TRUE if the new position is valid, FALSE otherwise.

RWBoolean
operator()();

Advances the iterator one position. Returns TRUE if the new position is valid, FALSE otherwise.

RWTValHashDictionary*
container() const;

Returns a pointer to the collection over which this iterator is iterating.

K
key() const;

Returns the key at the iterator's current position. The results are undefined if the iterator is no longer valid.

void
reset();

Resets the iterator to the state it had immediately after construction.

void
reset(RWTValHashDictionary& c);

Resets the iterator to iterate over the collection c.

V
value() const;

Returns the value at the iterator's current position. The results are undefined if the iterator is no longer valid.