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

Deprecated. Provides a const iterator for RWTPtrMultiMap. More...

#include <rw/tpmmap.h>

Public Member Functions
	RWTPtrMultiMapConstIterator (const RWTPtrMultiMap< K, T, C, A > &m)
	RWTPtrMultiMapConstIterator (const RWTPtrMultiMapIterator< K, T, C, A > &itr)
const RWTPtrMultiMap< K, T, C, A > *	container () const
const K *	key () const
const K *	operator() ()
bool	operator++ ()
void	reset ()
void	reset (const RWTPtrMultiMap< K, T, C, A > &m)
const 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 RWTPtrMultiMapConstIterator< K, T, C, A >

Deprecated

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

RWTPtrMultiMapConstIterator provides a const iterator interface to the C++ Standard Library-based RWTPtrMultiMap collection. A const iterator prohibits changes to the collection it iterates through.

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 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/tpmmap.h>
template <class K, class T, class C, class A = std::allocator<T*> >
class RWTPtrMultiMapConstIterator

Persistence

None

Constructor & Destructor Documentation

RWTPtrMultiMapConstIterator() [1/2]

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

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

inline

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

RWTPtrMultiMapConstIterator() [2/2]

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

RWTPtrMultiMapConstIterator< K, T, C, A >::RWTPtrMultiMapConstIterator ( const RWTPtrMultiMapIterator< 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

container()

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

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

inline

Returns a pointer to the collection being iterated over.

key()

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

const K * RWTPtrMultiMapConstIterator< 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.

operator()()

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

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

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.

operator++()

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

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

reset() [1/2]

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

void RWTPtrMultiMapConstIterator< K, T, C, A >::reset ( )

inline

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

reset() [2/2]

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

void RWTPtrMultiMapConstIterator< K, T, C, A >::reset ( const 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.

value()

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

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

inline

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