RWTValMultiMapConstIterator<K,T,C,A>

Module:  Essential Tools Module   Group:  STL-based Collection Classes

Does not inherit

• Local Index
• Synopsis
• Description
• Persistence
• Public Constructors
• Public Member Operators
• Public Member Functions

Members

container() key()

operator()() operator++()

reset() RWTValMultiMapConstIterator<K,T,C,A>()

value()

#include <rw/tvmmap.h>
template <class K, class T, class C, 
          class A=std::allocator<T> >
class  RWTValMultiMapConstIterator

RWTValMultiMapConstIterator provides a const iterator for RWTValMultiMap. A const iterator prohibits any changes to the collection it iterates over.

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 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.

None

RWTValMultiMapConstIterator<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 is 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 now references 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, true is returned. Note: no postincrement operation is provided.

const RWTValMultiMap<K,T,C,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(RWTValMultiMap<K,T,C,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 RWTValMultiMap to reset() resets the iterator on the new container.

const 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.