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

Provides an iterator for RWTValMap. More...

#include <rw/tvmap.h>

List of all members.

Public Member Functions
	RWTValMapIterator (RWTValMap< K, T, C, A > &h)
bool	operator++ ()
bool	operator() ()
RWTValMap< K, T, C,A > *	container () const
K	key () const
void	reset ()
void	reset (RWTValMap< K, T, C, A > &h)
T	value () const

---

Detailed Description

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>
class RWTValMapIterator< K, T, C, A >

RWTValMapIterator provides an iterator interface to the C++ Standard Library collection represented by RWTValMap. (An STL iterator interface is provided through RWTValMap::iterator.)

The order of iteration over an RWTValMap is dependent on the supplied comparator object 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 pre-increment or operator()().

For both operator++() and operator()(), iterating past the last element returns a value equivalent to 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/tvmap.h>
 RWTValMap<K,T,C,A> vm;
 RWTValMapIterator<K,T,C,A> itr(vm);

Persistence

None

Examples

 #include <rw/tvmap.h>
 #include <rw/cstring.h>
 #include <iostream>
 #include <functional>
 
 int main()
 {
    RWTValMap<RWCString, int, std::greater<RWCString> > age;
    RWTValMapIterator<RWCString, int, std::greater<RWCString> > itr(age);
 
    age.insert("John", 30);
    age.insert("Steve", 17);
    age.insert("Mark", 24);
 
    //Insertion is rejected, no duplicates allowed
    age.insert("Steve", 24);
 
    while(itr()) {
      std::cout << itr.key()
                << "\'s age is "
                << itr.value()
                << std::endl;
    }
 
    return 0;
 }

Program Output:

 Steve's age is 17
 Mark's age is 24
 John's age is 30

---

Constructor & Destructor Documentation

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

RWTValMapIterator< K, T, C, A >::RWTValMapIterator

(

RWTValMap< K, T, C, A > &

h

)

[inline]

Creates an iterator for the map h. The iterator begins in an undefined state and must be advanced before the first association is accessible.

---

Member Function Documentation

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

RWTValMap<K,T,C ,A >* RWTValMapIterator< K, T, C, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

K RWTValMapIterator< K, T, C, A >::key

(

)

const [inline]

Returns the key portion of the association currently referenced by self.

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

bool RWTValMapIterator< K, T, C, A >::operator()

(

void

)

[inline]

Advances self to the next element. If the iterator has advanced past the last element in the collection, returns false, otherwise returns true.

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

bool RWTValMapIterator< K, T, C, A >::operator++

(

)

[inline]

Advances self to the next element. If the iterator has been reset or just created self will reference the first element. If, before iteration, self pointed to the last association in the map, self will reference an undefined value and will return false. Otherwise, it returns true.

Note:

No post-increment operator is provided.

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

void RWTValMapIterator< K, T, C, A >::reset

(

RWTValMap< K, T, C, A > &

h

)

[inline]

Resets the iterator so that after being advanced it references the first element of the collection h.

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

void RWTValMapIterator< K, T, C, A >::reset

(

void

)

[inline]

Resets the iterator so that after being advanced it references the first element of the collection.

template<class K, class T, class C, class A = std:: allocator < std::pair<K const, T> >>

T RWTValMapIterator< K, T, C, A >::value

(

void

)

const [inline]

Returns the value portion of the association referenced by self.