RWTPtrDlistConstIterator< T, A > Class Template Reference

Provides a const iterator for RWTPtrDlist. More...

#include <rw/tpdlist.h>

List of all members.

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

---

Detailed Description

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

• RWTPtrDlistConstIterator provides a const iterator interface to the C++ Standard Library-based collection represented by RWTPtrDlist. This iterator prohibits any changes to the underlying collection.

The order of iteration over an RWTPtrDlist is dependent on the order of the values 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 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. For operator--, decrementing past the first element returns a value equivalent to false.

Synopsis

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

Persistence

None

---

Constructor & Destructor Documentation

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

RWTPtrDlistConstIterator< T, A >::RWTPtrDlistConstIterator

(

const RWTPtrDlist< T, A > &

l

)

[inline]

Constructs a const iterator for the list l. 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* >>

RWTPtrDlistConstIterator< T, A >::RWTPtrDlistConstIterator

(

const RWTPtrDlistIterator< T, A > &

itr

)

[inline]

Constructs a const iterator from the iterator itr. The 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 RWTPtrDlist<T ,A >* RWTPtrDlistConstIterator< T, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

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

const T* RWTPtrDlistConstIterator< 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. If no such element exists, returns rwnil. Leaves self referencing the found item, or "past the end."

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

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

(

const T *

a

)

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

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

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

const T* RWTPtrDlistConstIterator< 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 RWTPtrDlistConstIterator< T, 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 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 RWTPtrDlistConstIterator< T, A >::operator+=

(

size_t

n

)

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

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

bool RWTPtrDlistConstIterator< T, A >::operator--

(

)

Moves self back to the immediately previous element. If the iterator has been reset or just created, this operator returns a value equivalent to false, otherwise it returns a value equivalent to 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 references the last item in the list.

Note:

No post-increment operator is provided.

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

bool RWTPtrDlistConstIterator< T, A >::operator-=

(

size_t

n

)

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

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

void RWTPtrDlistConstIterator< T, A >::reset

(

const RWTPtrDlist< T, A > &

s

)

[inline]

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

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

void RWTPtrDlistConstIterator< T, A >::reset

(

void

)

[inline]

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