rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWTValMultiSetIterator< T, C, A > Class Template Reference
[STL-based Collections]

Provides an iterator for RWTValMultiSet. More...

#include <rw/tvmset.h>

List of all members.

Public Member Functions

 RWTValMultiSetIterator (RWTValMultiSet< T, C, A > &h)
bool operator++ ()
bool operator() ()
RWTValMultiSet< T, C,A > * container () const
key () const
void reset ()
void reset (RWTValMultiSet< T, C, A > &h)

Detailed Description

template<class T, class C, class A = std:: allocator < T >>
class RWTValMultiSetIterator< T, C, A >

RWTValMultiSetIterator provides an iterator interface to the C++ Standard Library-based collection represented by RWTValMultiSet. (An STL iterator interface is provided through RWTValMultiMSet::iterator.)

The order of iteration over an RWTValMultiSet 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 pre-increment 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.

Synopsis

 #include <rw/tvmset.h>
 RWTValMultiSet<T,C> vs;
 RWTValMultiSetIterator<T,C> itr(vs);

Persistence

None

Examples

 #include <rw/tvmset.h>
 #include <iostream>
 #include <rw/cstring.h>
 #include <functional>
 
 int main()
 {
    RWTValMultiSet<RWCString, std::greater<RWCString> > a;
    RWTValMultiSetIterator<RWCString,
      std::greater<RWCString> > itr(a);
 
    a.insert("John");
    a.insert("Steve");
    a.insert("Mark");
    a.insert("Steve");
 
    while(itr()) {
      std::cout << itr.key() << std::endl;
    }
 
    return 0;
 }

Program Output:

 Steve
 Steve
 Mark
 John

Constructor & Destructor Documentation

template<class T, class C, class A = std:: allocator < T >>
RWTValMultiSetIterator< T, C, A >::RWTValMultiSetIterator ( RWTValMultiSet< T, C, A > &  h  )  [inline]

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


Member Function Documentation

template<class T, class C, class A = std:: allocator < T >>
RWTValMultiSet<T,C ,A >* RWTValMultiSetIterator< T, C, A >::container (  )  const [inline]

Returns a pointer to the collection being iterated over.

template<class T, class C, class A = std:: allocator < T >>
T RWTValMultiSetIterator< T, C, A >::key (  )  const [inline]

Returns the value pointed to by self.

template<class T, class C, class A = std:: allocator < T >>
bool RWTValMultiSetIterator< T, C, A >::operator() ( void   )  [inline]

Advances self to the next element, and returns true. Returns false if the iterator has advanced past the last element in the collection.

template<class T, class C, class A = std:: allocator < T >>
bool RWTValMultiSetIterator< T, C, A >::operator++ (  )  [inline]

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-set, self now references an undefined value, and false is returned. Otherwise, returns true.

Note:
No post-increment operator is provided.
template<class T, class C, class A = std:: allocator < T >>
void RWTValMultiSetIterator< T, C, A >::reset ( RWTValMultiSet< T, C, A > &  h  )  [inline]

Resets the iterator so that after being advanced, it will point to the first element of the collection h.

template<class T, class C, class A = std:: allocator < T >>
void RWTValMultiSetIterator< T, C, A >::reset ( void   )  [inline]

Resets the iterator so that after being advanced, it will point to the first element of the collection.

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

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