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

Provides a const iterator for RWTValMultiSet. More...

#include <rw/tvmset.h>

List of all members.

Public Member Functions
	RWTValMultiSetConstIterator (const RWTValMultiSet< T, C, A > &h)
	RWTValMultiSetConstIterator (const RWTValMultiSetIterator< T, C, A > &itr)
bool	operator++ ()
bool	operator() ()
const RWTValMultiSet< T, C,A > *	container () const
const T &	key () const
void	reset ()
void	reset (const RWTValMultiSet< T, C, A > &h)

---

Detailed Description

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

RWTValMultiSetConstIterator provides a const iterator for RWTValMultiSet. A const iterator prohibits any changes to the collection over which it iterates.

The order of iteration over an RWTValMultiSet is dependent on the supplied 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/tvmset.h>
 RWTValMultiSet<T,C> vs;
 RWTValMultiSetConstIterator<T,C> itr(vs);

Persistence

None

---

Constructor & Destructor Documentation

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

RWTValMultiSetConstIterator< T, C, A >::RWTValMultiSetConstIterator

(

const RWTValMultiSet< T, C, A > &

h

)

[inline]

Creates a const iterator for the multi-set h. 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 >>

RWTValMultiSetConstIterator< T, C, A >::RWTValMultiSetConstIterator

(

const RWTValMultiSetIterator< 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 RWTValMultiSet<T,C ,A >* RWTValMultiSetConstIterator< 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& RWTValMultiSetConstIterator< T, C, A >::key

(

)

const [inline]

Returns the value pointed to by self.

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

bool RWTValMultiSetConstIterator< T, C, A >::operator()

(

void

)

[inline]

Advances self to the next element and returns true. Returns false if the iterator has advanced past the last element in the collection.

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

bool RWTValMultiSetConstIterator< 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 multi-set, self now references an undefined value and false is returned. Otherwise, returns true.

Note:

No post-increment operator is provided.

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

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

(

const RWTValMultiSet< T, C, A > &

h

)

[inline]

Resets the iterator so that after being advanced, it points to the first element of the collection h.

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

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

(

void

)

[inline]

Resets the iterator so that after being advanced, it points to the first element of the collection.