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

#include<rw/tvset.h>
template <class T, class C, class A=std::allocator<T> >
class  RWTValSetConstIterator

RWTValSetConstIterator provides a const iterator for class RWTValSet. A const iterator prohibits changes to the collection over which it is iterating.

The order of iteration over an RWTValSet is dependent on the supplied comparator object parameter C as applied to the values stored in the container.

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

RWTValSetConstIterator<T,C,A>(RWTValSet<T,C,A>& s);

Creates an iterator for the set s. The iterator begins in an undefined state and must be advanced before the first element is accessible

bool
operator()();

Advances self to the next element. If the iterator has advanced past the last element in the collection, false is returned. Otherwise, true is returned.

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 set, self now references an undefined value and false is returned. Otherwise, true is returned. Note: no postincrement operator is provided.

const RWTValSet<T,C,A>*
container() const; 

Returns a pointer to the collection being iterated over.

const T&
key() const; 

Returns the value referenced by self.

void
reset();
void
reset(RWTValSet<T,C,A>& s);

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 RWTValSet to reset() resets the iterator on that container.

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