SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Provides an iterator for RWTValMultiMap. More...
#include <rw/tvmmap.h>
Public Member Functions | |
RWTValMultiMapIterator (RWTValMultiMap< K, T, C, A > &m) | |
bool | operator++ () |
bool | operator() () |
RWTValMultiMap< K, T, C,A > * | container () const |
K | key () const |
void | reset () |
void | reset (RWTValMultiMap< K, T, C, A > &h) |
T | value () const |
RWTValMultiMapIterator provides an iterator interface to the C++ Standard Library-based collection represented by RWTValMultiMap. (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 pre-increment 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==
and operator<
defined. This requirement is imposed by the C++ Standard Library.
#include <rw/tvmmap.h> RWTValMultiMap<K,T,C,A> vm; RWTValMultiMapIterator<K,T,C,A> itr(vm);
None
#include <rw/tvmmap.h> #include <rw/cstring.h> #include <iostream> #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:
John's age is 30 Steve's age is 24 Steve's age is 17 Mark's age is 24
RWTValMultiMapIterator< K, T, C, A >::RWTValMultiMapIterator | ( | RWTValMultiMap< K, T, C, A > & | m | ) | [inline] |
Creates an iterator for the multi-map m. The iterator begins in an undefined state and must be advanced before the first association is accessible.
RWTValMultiMap<K,T,C ,A >* RWTValMultiMapIterator< K, T, C, A >::container | ( | ) | const [inline] |
Returns a pointer to the collection being iterated over.
K RWTValMultiMapIterator< K, T, C, A >::key | ( | ) | const [inline] |
Returns the key portion of the association currently referenced by self.
bool RWTValMultiMapIterator< K, T, C, A >::operator() | ( | void | ) | [inline] |
Advances self to the next element and returns true
. Returns false
if the iterator has advanced past the last element in the collection.
bool RWTValMultiMapIterator< K, T, C, A >::operator++ | ( | ) | [inline] |
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 now references an undefined value and false
is returned. Otherwise, returns true
.
void RWTValMultiMapIterator< K, T, C, A >::reset | ( | RWTValMultiMap< K, T, C, A > & | h | ) | [inline] |
Resets the iterator so that after being advanced, it references the first element of the collection h.
void RWTValMultiMapIterator< K, T, C, A >::reset | ( | void | ) | [inline] |
Resets the iterator so that after being advanced, it references the first element of the collection.
T RWTValMultiMapIterator< K, T, C, A >::value | ( | void | ) | const [inline] |
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.