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

Provides an iterator for RWTPtrSortedDlist. More...

#include <rw/tpsrtdli.h>

List of all members.

Public Member Functions
	RWTPtrSortedDlistIterator (RWTPtrSortedDlist< T, C, A > &l)
bool	operator++ ()
bool	operator-- ()
bool	operator+= (size_t n)
bool	operator-= (size_t n)
T *	operator() ()
RWTPtrSortedDlist< T, C,A > *	container () const
T *	findNext (const T *a)
T *	findNext (bool(*fn)(T *, void *), void *d)
T *	key () const
T *	remove ()
T *	removeNext (const T *a)
T *	removeNext (bool(*fn)(T *, void *), void *d)
void	reset ()
void	reset (RWTPtrSortedDlist< T, C, A > &l)

---

Detailed Description

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

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

The order of iteration over an RWTPtrSortedDlist is dependent on the comparator object parameter C 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 will return a value equivalent to boolean false. Continued increments will 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/tpsrtdli.h>
 RWTPtrSortedDlist<T,C,A> dl;
 RWTPtrSortedDlistIterator<T,C,A> itr(dl);

Persistence

None

Examples

 #include<rw/tpsrtdli.h>
 #include<iostream>
 #include<rw/cstring.h>
 #include<functional>

 int main() {
    RWTPtrSortedDlist<RWCString,std::less<RWCString> > a;
    RWTPtrSortedDlistIterator<RWCString,std::less<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
     Mark
     Steve
     Steve

---

Constructor & Destructor Documentation

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

RWTPtrSortedDlistIterator< T, C, A >::RWTPtrSortedDlistIterator

(

RWTPtrSortedDlist< T, C, 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 will be accessible.

---

Member Function Documentation

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

RWTPtrSortedDlist<T,C ,A >* RWTPtrSortedDlistIterator< 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* >>

T* RWTPtrSortedDlistIterator< T, C, 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. Otherwise returns rwnil. Leaves self referencing found item or "off the end." Client data may be passed through parameter d.

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

T* RWTPtrSortedDlistIterator< T, C, A >::findNext

(

const T *

a

)

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

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

T* RWTPtrSortedDlistIterator< T, C, 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 C, class A = std:: allocator < T* >>

T* RWTPtrSortedDlistIterator< T, C, 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 will be returned.

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

bool RWTPtrSortedDlistIterator< T, C, 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 point to an undefined 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 C, class A = std:: allocator < T* >>

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

(

size_t

n

)

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

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

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

(

)

Moves self back to the immediately previous element. If the iterator has been reset or just created, this operator will return false, otherwise it will return 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 C, class A = std:: allocator < T* >>

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

(

size_t

n

)

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

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

T* RWTPtrSortedDlistIterator< T, C, 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 prior item or in reset state.

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

T* RWTPtrSortedDlistIterator< T, C, 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. Otherwise returns rwnil. Leaves self referencing prior item or in reset state. Client data may be passed through parameter d.

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

T* RWTPtrSortedDlistIterator< T, C, 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. Otherwise returns rwnil. Leaves self referencing prior item or in reset state.

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

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

(

RWTPtrSortedDlist< T, C, A > &

l

)

[inline]

Resets the iterator so that after being advanced it will point to the first element of the collection l.

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

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

(

void

)

[inline]

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