RWTPtrMultiMapIterator(3C++) RWTPtrMultiMapIterator(3C++)
Name
RWTPtrMultiMapIterator<K,T,C> - Rogue Wave library class
Synopsis
#include<rw/tpmmap.h>
RWTPtrMultiMap<K,T,C> map;
RWTPtrMultiMapIterator<K,T,C> itr(map);
Standard C++ Library Dependent!RWTPtrMultiMapIterator requires the Standard C++ Library.
DescriptionRWTPtrMultiMapIterator is supplied with Tools 7 to provide an iterator
interface to the new Standard Library based collections with backward
compatibility to the Tools 6 container iterators. The order of iteration
over an RWTPtrMultiMap is dependent on the comparator object of the
container as applied to the key values 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/tpmmap.h>
#include<iostream.h>
#include<rw/cstring.h>
#include<utility>
int main(){
RWTPtrMultiMap<RWCString,int,less<RWCString> > age;
RWTPtrMultiMapIterator<RWCString,int,less<RWCString> > itr(age);
age.insert(new RWCString("John"), new int(30));
Page 1
RWTPtrMultiMapIterator(3C++) RWTPtrMultiMapIterator(3C++)
age.insert(new RWCString("Steve"),new int(17));
age.insert(new RWCString("Mark"), new int(24));
age.insert(new RWCString("Steve"),new int(24));
for(;itr();)
cout << *itr.key() << "'s age is " << *itr.value() << endl;
return 0;
}
Program Output
John's age is 30
Mark's age is 24
Steve's age is 17
Steve's age is 24
Public Constructors
RWTPtrMultiMapIterator<K,T,C>(const RWTPtrMultiMap<K,T,C>& m);
Creates an iterator for the multimap m. The iterator begins in an
undefined state and must be advanced before the first element will be
accessible
Public Member Operators
K*
operator()();
Advances self to the next element, dereferences the resulting iterator
and returns its key. If the iterator has advanced past the last item in
the container, the element returned will be a nil pointer equivalent to
boolean false.
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 multimap, self
will now point to an undefined value and a value equivalent to false will
be returned. Otherwise, a value equivalent to true is returned. Note: no
Page 2
RWTPtrMultiMapIterator(3C++) RWTPtrMultiMapIterator(3C++)
post-increment operator is provided.
Public Member Functions
RWTPtrMultiMap<K,T,C>*
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.
Undefined if self is not referencing a value within the multimap.
void
reset();
void
reset(RWTPtrMultiMap<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 RWTPtrMultiMap
to reset() will reset the iterator on that container.
T*
value();
Returns the value portion of the association referenced by self.
Undefined if self is not referencing a value within the multimap.
Page 3