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

Provides an iterator for RWTPtrMap. More...

#include <rw/tpmap.h>

List of all members.

Public Member Functions
	RWTPtrMapIterator (RWTPtrMap< K, T, C, A > &rwm)
bool	operator++ ()
K *	operator() ()
RWTPtrMap< K, T, C,A > *	container () const
K *	key () const
void	reset ()
void	reset (RWTPtrMap< K, T, C, A > &m)
T *	value () const

---

Detailed Description

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

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

The order of iteration over an RWTPtrMap is dependent on the comparator object supplied 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 will return a value equivalent to boolean false. Continued increments will 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/tpmap.h>
 RWTPMap<K,T,C> map;
 RWTPMapIterator<K,T,C> itr(map);

Persistence

None

Examples

 #include <rw/tpmap.h>
 #include <iostream>
 #include <rw/cstring.h>
 
 int main() {
    RWTPtrMap<RWCString,int,std::less<RWCString> > age;
    RWTPtrMapIterator<RWCString,int,std::less<RWCString> > itr(age);
  
    age.insert(new RWCString("John") ,new int(30));
    age.insert(new RWCString("Steve"),new int(17));
    age.insert(new RWCString("Mark") ,new int(24));
 
    while(itr()) {
      std::cout << *itr.key() << "\'s age is " << *itr.value()
                << std::endl;
    }
 
    age.clearAndDestroy();
    return 0;
 }

Program Output:

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

---

Constructor & Destructor Documentation

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

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

(

RWTPtrMap< K, T, C, A > &

rwm

)

[inline]

Creates an iterator for the map rwm. The iterator begins in an undefined state and must be advanced before the first element will be accessible.

---

Member Function Documentation

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

RWTPtrMap<K,T,C ,A >* RWTPtrMapIterator< 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* RWTPtrMapIterator< K, T, C, A >::key

(

)

const [inline]

Returns the key portion of the association currently referenced by self. Undefined if self is not referencing a value within the map.

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

K* RWTPtrMapIterator< K, T, C, A >::operator()

(

void

)

[inline]

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, rwnil will be returned.

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

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

(

)

[inline]

Advances self to the next element. If the iterator has been reset or just created self will now reference the first element. If, before iteration, self referenced the last association in the multimap, self will now point to an undefined value, and a value equivalent to false will be returned. Otherwise, a value equivalent to true is returned.

Note:

No post-increment operator is provided.

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

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

(

RWTPtrMap< K, T, C, A > &

m

)

[inline]

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

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

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

(

void

)

[inline]

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

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

T* RWTPtrMapIterator< K, T, C, A >::value

(

void

)

const [inline]

Returns the value portion of the association pointed to by self. Undefined if self is not referencing a value within the map.