Module: Essential Tools Module Group: STL Extension-based Collection
Does not inherit
#include <rw/tvhmmap.h> template <class K, class T, class H, class EQ, class A=std::allocator<T> > class RWTValHashMultiMapConstIterator
RWTValHashMultiMapConstIterator provides a const iterator for RWTValHashMultiMap. A const iterator prohibits any changes to the collection it is iterating over.
Iteration over an RWTValHashMultiMap is pseudorandom and dependent on the capacity of the underlying hash table and the hash function being used. The only usable relationship between consecutive elements is that elements which are defined to be equivalent by the equivalence object, EQ, will remain adjacent.
The current item referenced by this iterator is undefined after construction or after a call to reset(). The iterator becomes valid after being advanced with either a preincrement or operator().
For both operator++ and operator(), iterating past the last element returns a value equivalent to boolean false. Continued increments return a value equivalent to false until reset() is called.
The value type must have operator== defined. This requirement is imposed by the Standard C++ Library.
Creates an iterator for the hash multimap h. The iterator begins in an undefined state and must be advanced before the first element is accessible.
Advances self to the next element, dereferences the resulting iterator and returns false if the iterator has advanced past the last item in the container and true otherwise.
Advances self to the next element. If the iterator has been reset or just created self now references the first element. If, before iteration, self referenced the last association in the multimap, self now references an undefined value and false is returned. Otherwise, true is returned. Note: no postincrement operator is provided.
const RWTValHashMultiMap<K,T,H,EQ,A>* container() const;
Returns a pointer to the collection being iterated over.
const K& key() const;
Returns the key portion of the association currently referenced by self.
void reset(); void reset(RWTValHashMultiMap<K,T,H,EQ,A>& h);
Resets the iterator so that after being advanced it references the first element of the collection. Using reset() with no argument resets the iterator on the current container. Supplying a RWTValHashMultiMap with reset() resets the iterator on that container.
const T& value();
Returns the value portion of the association referenced by self.
©2004 Copyright Quovadx, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Quovadx, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.