RWTValMultiMapIterator(3C++) RWTValMultiMapIterator(3C++)
Name
RWTValMultiMapIterator<K,T,C> - Rogue Wave library class
Synopsis
#include<rw/tvmmap.h>
RWTValMultiMap<K,T,C> vm;
RWTValMultiMapIterator<K,T,C> itr(vm);
Standard C++ Library Dependent!RWTValMultiMapIterator requires the Standard C++ Library.
DescriptionRWTValMultiMapIterator is supplied with Tools.h++ 7 to provide an
iterator interface for class RWTValMultiMap that has backward
compatibility with the container iterators provided in Tools.h++ 6.x. 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.
Persistence
None
Examples
#include<rw/tvmmap.h>
#include<iostream.h>
#include<rw/cstring.h>
int main(){
RWTValMultiMap<RWCString,int,greater<RWCString> > a;
RWTValMultiMapIterator
<RWCString,int,greater<RWCString> > itr(a);
a.insert("John", 30);
a.insert("Steve",17);
a.insert("Mark",24);
a.insert("Steve",24);
for(;itr();)
cout << itr.key() << "'s age is " << itr.value() << endl;
Page 1
RWTValMultiMapIterator(3C++) RWTValMultiMapIterator(3C++)
return 0;
}
Program Output
Steve's age is 17
Steve's age is 24
Mark's age is 24
Public Constructors
John's age is 30
RWTValMultiMapIterator<K,T,C>
(RWTValMultiMap<K,T,C>&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.
Public Member Operators
RWBoolean
operator()();
Advances self to the next element. If the iterator has advanced past the
last item in the collection, returns false. Otherwise, returns true.
RWBoolean
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.
Public Member Functions
RWTValMultiMap<K,T,C>*
container() const;
Returns a pointer to the collection being iterated over.
Page 2
RWTValMultiMapIterator(3C++) RWTValMultiMapIterator(3C++)
K
key() const;
Returns the key portion of the association currently referenced by self.
void
reset();
void
reset(RWTValMultiMap<K,T,C>& 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.
Page 3
