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

Provides a const iterator for RWTPtrMap. More...

#include <rw/tpmap.h>

List of all members.

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

---

Detailed Description

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

RWTPtrMapIterator provides a const iterator interface to the C++ Standard Library-based RWTPtrMap collection. As a const iterator, it prohibits any change to the collection upon which it iterates.

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

Synopsis

 #include <rw/tpmap.h>
 template <class K, class T, class C,
           class A=std::allocator<T*> >
 class  RWTPtrMapConstIterator

Persistence

None

---

Constructor & Destructor Documentation

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

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

(

const RWTPtrMap< K, T, C, A > &

rwm

)

[inline]

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

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

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

(

const RWTPtrMapIterator< K, T, C, A > &

itr

)

[inline]

Creates a const iterator from the iterator itr. The const iterator begins in an undefined state and must be advanced before the first element is accessible.

---

Member Function Documentation

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

const RWTPtrMap<K,T,C ,A >* RWTPtrMapConstIterator< 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*> >>

const K* RWTPtrMapConstIterator< 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*> >>

const K* RWTPtrMapConstIterator< 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 RWTPtrMapConstIterator< K, 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 multimap, self now points to an undefined value, and a value equivalent to false is 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 RWTPtrMapConstIterator< K, T, C, A >::reset

(

const 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 RWTPtrMapConstIterator< 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*> >>

const T* RWTPtrMapConstIterator< 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.