Module: Essential Tools Module Group: STL-based Collection Classes
Does not inherit
#include<rw/tvmmap.h> RWTValMultiMap<K,T,C,A> vm; RWTValMultiMapIterator<K,T,C,A> itr(vm);
RWTValMultiMapIterator provides the traditional Tools iterator interface to the standard library-based collections. (An STL iterator interface is provided through RWTValMultiMap::iterator.)
The order of iteration for an RWTValMultiMap is dependent upon the comparator object as applied to the keys of the stored associations.
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 will return a value equivalent to boolean false. Continued increments will return a value equivalent to false until reset() is called.
The value type must have operator== and operator< defined. This requirement is imposed by the C++ Standard Library.
None
#include<rw/tvmmap.h> #include<iostream> #include<rw/cstring.h> #include<functional> int main(){ RWTValMultiMap<RWCString, int, std::greater<RWCString> > age; RWTValMultiMapIterator <RWCString, int, std::greater<RWCString> > itr(age); age.insert("John", 30); age.insert("Steve", 17); age.insert("Mark", 24); age.insert("Steve", 24); while(itr()) { std::cout << itr.key() << "\'s age is " << itr.value() << std::endl; } return 0; }
Program Output:
Steve's age is 17 Steve's age is 24 Mark's age is 24 John's age is 30
RWTValMultiMapIterator<K,T,C,A>(RWTValMultiMap<K,T,C,A>& m);
Creates an iterator for the multi-map m. The iterator begins in an undefined state and must be advanced before the first association will be accessible.
bool operator()();
Advances self to the next element. If the iterator has advanced past the last item in the collection, returns false. Otherwise, returns true.
bool operator++();
Advances self to the next element. If the iterator has been reset or just created self will now reference the first element. If, before iteration, self referenced the last association in the multi-map, self will now reference an undefined value and false will be returned. Otherwise, true is returned. Note: no postincrement operation is provided.
RWTValMultiMap<K,T,C,A>* container() const;
Returns a pointer to the collection being iterated over.
K key() const;
Returns the key portion of the association currently referenced by self.
void reset(); void reset(RWTValMultiMap<K,T,C,A>& h);
Resets the iterator so that after being advanced it will reference the first element of the collection. Using reset() with no argument will reset the iterator on the current container. Supplying a RWTValMultiMap to reset() will reset the iterator on the new container.
T value();
Returns the value portion of the association referenced by self.
© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, 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.