RWTValHashDictionaryIterator(3C++)

Name
     RWTValHashDictionaryIterator<K,V> - Rogue Wave library class

Synopsis
              #include <rw/tvhdict.h>



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

Please Note!
     If you do not have the Standard C++ Library, use the interface described
     here.  Otherwise, use the interface to RWTValHashMapIterator described in
     the Class Reference.


Description
     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.

Persistence
     None

Public Constructor
              RWTValHashDictionaryIterator(RWTValHashDictionary& c);


     Constructs an iterator to be used with the dictionary c.





Public Operators
              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.

Public Member Functions
              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.