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

Provides a const iterator for RWTPtrMultiSet. More...

#include <rw/tpmset.h>

List of all members.

Public Member Functions
	RWTPtrMultiSetConstIterator (const RWTPtrMultiSet< T, C, A > &m)
	RWTPtrMultiSetConstIterator (const RWTPtrMultiSetIterator< T, C, A > &itr)
bool	operator++ ()
const T *	operator() ()
const RWTPtrMultiSet< T, C,A > *	container () const
const T *	key () const
void	reset ()
void	reset (const RWTPtrMultiSet< T, C, A > &t)

---

Detailed Description

template<class T, class C, class A = std:: allocator < T* >>
class RWTPtrMultiSetConstIterator< T, C, A >

RWTPtrMultiSetConstIterator provides a const iterator interface to the C++ Standard Library-based collection represented by RWTPtrMultiSet.

The order of iteration over an RWTPtrMultiSet is dependent upon the comparator object parameter C as applied to the values stored in the container.

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

Persistence

None

---

Constructor & Destructor Documentation

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

RWTPtrMultiSetConstIterator< T, C, A >::RWTPtrMultiSetConstIterator

(

const RWTPtrMultiSet< T, C, A > &

m

)

[inline]

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

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

RWTPtrMultiSetConstIterator< T, C, A >::RWTPtrMultiSetConstIterator

(

const RWTPtrMultiSetIterator< 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 T , class C , class A = std:: allocator < T* >>

const RWTPtrMultiSet<T,C ,A >* RWTPtrMultiSetConstIterator< T, C, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

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

const T* RWTPtrMultiSetConstIterator< T, C, A >::key

(

)

const [inline]

Returns the stored value referenced by self. Undefined if self is not referencing a value within the list.

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

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

(

void

)

[inline]

Advances self to the next element, dereferences the resulting iterator, and returns its value. If the iterator has advanced past the last item in the container, rwnil will be returned.

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

bool RWTPtrMultiSetConstIterator< 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 multiset, 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 T , class C , class A = std:: allocator < T* >>

void RWTPtrMultiSetConstIterator< T, C, A >::reset

(

const RWTPtrMultiSet< T, C, A > &

t

)

[inline]

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

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

void RWTPtrMultiSetConstIterator< T, C, A >::reset

(

void

)

[inline]

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