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

Provides a const iterator for RWTValSortedDlist. More...

#include <rw/tvsrtdli.h>

List of all members.

Public Member Functions
	RWTValSortedDlistConstIterator (const RWTValSortedDlist< T, C, A > &s)
	RWTValSortedDlistConstIterator (const RWTValSortedDlistIterator< T, C, A > &itr)
bool	operator++ ()
bool	operator-- ()
bool	operator+= (size_t n)
bool	operator-= (size_t n)
bool	operator() ()
const RWTValSortedDlist< T, C,A > *	container () const
bool	findNext (const T &a)
bool	findNext (bool(*fn)(const T &, void *), void *d)
const T &	key () const
void	reset ()
void	reset (const RWTValSortedDlist< T, C, A > &l)

---

Detailed Description

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

RWTValSortedDlistConstIterator provides a const iterator to RWTValSortedDlist. A const iterator prohibits changes to the collection over which it iterates.

The order of iteration over an RWTValSortedDlist is dependent on the supplied comparator object 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/tvsrtdli.h>
 template <class T, class C, class A=std::allocator<T> >
 class  RWTValSortedDlistConstIterator

Persistence

None

---

Constructor & Destructor Documentation

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

RWTValSortedDlistConstIterator< T, C, A >::RWTValSortedDlistConstIterator

(

const RWTValSortedDlist< T, C, A > &

s

)

[inline]

Creates a const iterator for the sorted dlist s. 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 >>

RWTValSortedDlistConstIterator< T, C, A >::RWTValSortedDlistConstIterator

(

const RWTValSortedDlistIterator< 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 RWTValSortedDlist<T,C ,A >* RWTValSortedDlistConstIterator< 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 >>

bool RWTValSortedDlistConstIterator< T, C, A >::findNext	(	bool(*)(const T &, void *)	fn,
		void *	d
	)

Advances self to the first element t encountered by iterating forward, such that the expression ((*fn)(t,d)) is true. Returns true if such an element if found, otherwise false. Client data may be passed through parameter d.

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

bool RWTValSortedDlistConstIterator< T, C, A >::findNext

(

const T &

a

)

Advances self to the first element t encountered by iterating forward, such that the expression (t == a) is true. Returns true if such an element if found, otherwise false.

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

const T& RWTValSortedDlistConstIterator< T, C, A >::key

(

)

const [inline]

Returns the stored value referenced by self.

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

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

(

void

)

[inline]

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

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

bool RWTValSortedDlistConstIterator< T, C, A >::operator++

(

)

Advances self to the next element. If the iterator has been reset or just created, self references the first element. If, before iteration, self referenced the last value in the list, self now points to an undefined value distinct from the reset value and the operator returns false. Otherwise, the operator returns true.

Note:

No post-increment operator is provided.

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

bool RWTValSortedDlistConstIterator< T, C, A >::operator+=

(

size_t

n

)

Behaves as if the operator++() member function had been applied n times.

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

bool RWTValSortedDlistConstIterator< T, C, A >::operator--

(

)

Moves self back to the immediately previous element. If the iterator has been reset or just created, this operator returns false, otherwise it returns true. If self references the first element, it is now in the reset state. If self has been iterated past the last value in the list, it now points to the last item in the list.

Note:

No post-decrement operator is provided.

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

bool RWTValSortedDlistConstIterator< T, C, A >::operator-=

(

size_t

n

)

Behaves as if the operator--() member function had been applied n times.

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

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

(

const RWTValSortedDlist< T, C, A > &

l

)

[inline]

Resets the iterator so that after being advanced, it references the first element of the collection l.

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

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

(

void

)

[inline]

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