RWTPtrSlistConstIterator< T, A > Class Template Reference
[STL Extension-based Collections]

Provides a const iterator for RWTPtrSlist. More...

#include <rw/tpslist.h>

List of all members.

Public Member Functions
	RWTPtrSlistConstIterator (const RWTPtrSlist< T, A > &lst)
	RWTPtrSlistConstIterator (const RWTPtrSlistIterator< T, A > &itr)
bool	operator++ ()
bool	operator+= (size_t n)
const T *	operator() ()
const T *	findNext (const T *a)
const T *	findNext (bool(*fn)(T *, void *), void *d)
const T *	key () const
void	reset ()
void	reset (const RWTPtrSlist< T, A > &s)

---

Detailed Description

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

RWTPtrSlistConstIterator provides a const iterator interface to C++ Standard Library-based RWTPtrSlist collections. A const iterator does not change anything in the data structure it iterates over.

The order of iteration over an RWTPtrSlist is dependent upon the order of insertion of items into 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.

Synopsis

 #include <rw/tpslist.h>
 template <class T, class A=std::allocator<T*> > class
 RWTPtrSlistConstIterator

Persistence

None

---

Constructor & Destructor Documentation

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

RWTPtrSlistConstIterator< T, A >::RWTPtrSlistConstIterator

(

const RWTPtrSlist< T, A > &

lst

)

[inline]

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

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

RWTPtrSlistConstIterator< T, A >::RWTPtrSlistConstIterator

(

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

const T* RWTPtrSlistConstIterator< T, A >::findNext	(	bool(*)(T *, void *)	fn,
		void *	d
	)

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

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

const T* RWTPtrSlistConstIterator< T, A >::findNext

(

const T *

a

)

Returns the first element t encountered by iterating self forward, such that the expression (*t == *a) is true. If no such element is found, returns rwnil. Leaves self referencing the found item or "off the end."

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

const T* RWTPtrSlistConstIterator< T, A >::key

(

)

const [inline]

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

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

const T* RWTPtrSlistConstIterator< T, 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 is returned.

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

bool RWTPtrSlistConstIterator< T, A >::operator++

(

)

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 list, self now references an undefined value distinct from the reset 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 A = std:: allocator < T* >>

bool RWTPtrSlistConstIterator< T, A >::operator+=

(

size_t

n

)

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

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

void RWTPtrSlistConstIterator< T, A >::reset

(

const RWTPtrSlist< T, A > &

s

)

[inline]

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

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

void RWTPtrSlistConstIterator< T, A >::reset

(

void

)

[inline]

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