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

Provides an iterator for RWTPtrDlist. More...

#include <rw/tpdlist.h>

List of all members.

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

---

Detailed Description

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

RWTPtrDlistIterator provides an iterator interface to the C++ Standard Library-based collection represented by RWTPtrDlist. (An STL iterator interface is provided through RWTPtrDlist::iterator.)

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>
 RWTPtrDlist<T,A> dl;
 RWTPtrDlistIterator<T,A> itr(dl);

Persistence

None

Examples

 #include <rw/tpdlist.h>
 #include <iostream>
 #include <rw/cstring.h>
 
 int main() {
    RWTPtrDlist<RWCString> a;
    RWTPtrDlistIterator<RWCString> itr(a);
 
    a.insert(new RWCString("John"));
    a.insert(new RWCString("Steve"));
    a.insert(new RWCString("Mark"));
    a.insert(new RWCString("Steve"));
 
    while(itr()) {
      std::cout << *itr.key() << std::endl;
    }
 
    a.clearAndDestroy();
    return 0;
 }

Program Output:

 John
 Steve
 Mark
 Steve

---

Constructor & Destructor Documentation

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

RWTPtrDlistIterator< T, A >::RWTPtrDlistIterator

(

RWTPtrDlist< T, A > &

l

)

[inline]

Creates an iterator for the list l. 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* >>

RWTPtrDlist<T ,A >* RWTPtrDlistIterator< T, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

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

T* RWTPtrDlistIterator< 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* >>

T* RWTPtrDlistIterator< 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 equivalent to false. Leaves self referencing the found item, or "past the end."

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

void RWTPtrDlistIterator< T, A >::insertAfterPoint

(

T *

p

)

Inserts the pointer p into the container directly after the element referenced by self.

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

T* RWTPtrDlistIterator< 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* >>

T* RWTPtrDlistIterator< 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 RWTPtrDlistIterator< T, A >::operator++

(

)

Advances self to the next element. If the iterator has been reset or just created, self will reference the first element. If, before iteration, self referenced the last value in the list, self will now reference an undefined value distinct from the reset value, and a value equivalent to false will be 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 RWTPtrDlistIterator< T, A >::operator+=

(

size_t

n

)

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

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

bool RWTPtrDlistIterator< 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 will now be in the reset state. If self has been iterated past the last value in the list, it will now reference the last item in the list.

Note:

No post-decrement operator is provided.

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

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

(

size_t

n

)

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

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

T* RWTPtrDlistIterator< T, A >::remove

(

)

Returns the stored value referenced by self and removes it from the collection. Undefined if self is not referencing a value within the list.

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

T* RWTPtrDlistIterator< T, A >::removeNext	(	bool(*)(T *, void *)	fn,
		void *	d
	)

Returns and removes 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.

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

T* RWTPtrDlistIterator< T, A >::removeNext

(

const T *

a

)

Returns and removes the first element t, encountered by iterating self forward, such that the expression (*t == *a) is true. If no such element exists, returns rwnil.

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

void RWTPtrDlistIterator< T, A >::reset

(

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 RWTPtrDlistIterator< T, A >::reset

(

void

)

[inline]

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