RWTPtrMultiMapConstIterator<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() RWTPtrMultiMapConstIterator<K,T,C,A>()

value()

#include <rw/tpmmap.h>
template <class K, class T, class C,
          class A=std::allocator<T*> >
class  RWTPtrMultiMapConstIterator

RWTPtrMultiMapConstIterator provides a const iterator interface to the standard library-based RWTPtrMultiMap collection. A const iterator prohibits changes to the collection it iteratres through.

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

RWTPtrMultiMapConstIterator<K,T,C,A>(const RWTPtrMultiMap<K,T,C,A>& m);

Creates a const iterator for the multimap m. The iterator begins in an undefined state and must be advanced before the first element is accessible

const 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 is a nil pointer equivalent to boolean false.

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 multimap, self now points to an undefined value and a value equivalent to false is returned. Otherwise, a value equivalent to true is returned. Note: no post-increment operator is provided.

const RWTPtrMultiMap<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. Undefined if self is not referencing a value within the multimap.

void
reset();
void
reset(RWTPtrMultiMap<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 RWTPtrMultiMap to reset() resets 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.

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