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

Provides an iterator for RWTPtrSlist. More...

#include <rw/tpslist.h>

List of all members.

Public Member Functions
	RWTPtrSlistIterator (RWTPtrSlist< T, A > &lst)
bool	operator++ ()
bool	operator+= (size_t n)
T *	operator() ()
RWTPtrSlist< 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 (RWTPtrSlist< T, A > &s)

---

Detailed Description

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

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

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 will return a value equivalent to boolean false. Continued increments will return a value equivalent to false until reset() is called.

If the slist is modified, the iterator is no longer valid. This is generally true for all iterators.

Synopsis

 #include<rw/tpslist.h>
 RWTPtrSlist<T,A> dl;
 RWTPtrSlistIterator<T,A> itr(dl);

Persistence

None

Examples

 #include <rw/tpslist.h>
 #include <iostream>
 #include <rw/cstring.h>

 int main() {
    RWTPtrSlist<RWCString> a;
    RWTPtrSlistIterator<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* >>

RWTPtrSlistIterator< T, A >::RWTPtrSlistIterator

(

RWTPtrSlist< T, A > &

lst

)

[inline]

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

---

Member Function Documentation

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

RWTPtrSlist<T ,A >* RWTPtrSlistIterator< T, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

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

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

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

void RWTPtrSlistIterator< T, A >::insertAfterPoint

(

T *

p

)

Inserts the pointer p into the container directly after the element pointed to by self. Leaves self referencing the prior item, or in reset condition.

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

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

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

(

)

Advances self to the next element. If the iterator has been reset or just created, self will now reference the first element. If, before iteration, self referenced the last association 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 RWTPtrSlistIterator< 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* >>

T* RWTPtrSlistIterator< T, A >::remove

(

)

Returns the stored value pointed to by self and removes it from the collection. Undefined if self is not referencing a value within the list. Leaves self referencing the prior item, or in reset condition.

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

T* RWTPtrSlistIterator< 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. Leaves self referencing the prior item, or in reset condition. Client data may be passed through parameter d.

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

T* RWTPtrSlistIterator< 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. Leaves self referencing the prior item, or in reset condition.

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

void RWTPtrSlistIterator< T, A >::reset

(

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

(

void

)

[inline]

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