RWTPtrMultiMapIterator< K, T, C, A > Class Template Reference

Deprecated. Provides an iterator for RWTPtrMultiMap. More...

#include <rw/tpmmap.h>

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

Detailed Description

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

Deprecated:

As of SourcePro 12.5, use RWTPtrMultiMap::iterator to iterate over the elements in this collection.

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

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 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/tpmmap.h>
RWTPtrMultiMap<K,T,C,A> map;
RWTPtrMultiMapIterator<K,T,C,A> itr(map);

Persistence

None

Example

#include <rw/tpmmap.h>
#include <iostream>
#include <rw/cstring.h>
#include <utility>

int main() {
   RWTPtrMultiMap<RWCString,int,std::less<RWCString> > age;
   RWTPtrMultiMapIterator<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));
   age.insert(new RWCString("Steve"),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
Steve's age is 24

Constructor & Destructor Documentation

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

RWTPtrMultiMapIterator< K, T, C, A >::RWTPtrMultiMapIterator ( RWTPtrMultiMap< K, T, C, A > &  m )

inline

Creates an iterator for the multimap m. 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 = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

RWTPtrMultiMap<K, T, C, A>* RWTPtrMultiMapIterator< K, T, C, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

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

K* RWTPtrMultiMapIterator< 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 multimap.

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

K* RWTPtrMultiMapIterator< 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 = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

bool RWTPtrMultiMapIterator< 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.

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

void RWTPtrMultiMapIterator< 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 = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

void RWTPtrMultiMapIterator< K, T, C, A >::reset ( RWTPtrMultiMap< 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 = std::less<K>, class A = std::allocator< std::pair<K* const, T*> >>

T* RWTPtrMultiMapIterator< K, T, C, A >::value ( void  ) const

inline

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