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

Provides a const iterator for RWTValMap. More...

#include <rw/tvmap.h>

List of all members.

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

---

Detailed Description

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

RWTValMapConstIterator provides a const iterator for RWTValMap. A const iterator prohibits changes to the underlying collection.

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 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/tvmap.h>
 RWTValMap<K,T,C,A> vm;
 RWTValMapConstIterator<K,T,C,A> itr(vm);

Persistence

None

---

Constructor & Destructor Documentation

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

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

(

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

h

)

[inline]

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

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

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

(

const RWTValMapIterator< 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 association is accessible.

---

Member Function Documentation

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

const RWTValMap<K,T,C ,A >* RWTValMapConstIterator< 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& RWTValMapConstIterator< 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 RWTValMapConstIterator< 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 RWTValMapConstIterator< 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 pointed to the last association in the map, self now references an undefined value and returns false, otherwise 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 RWTValMapConstIterator< K, T, C, A >::reset

(

const 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 RWTValMapConstIterator< 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> >>

const T& RWTValMapConstIterator< K, T, C, A >::value

(

void

)

const [inline]

Returns the value portion of the association referenced by self.