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

Provides an iterator for RWTValDlist. More...

#include <rw/tvdlist.h>

List of all members.

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

---

Detailed Description

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

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

The order of iteration over an RWTValDlist is dependent on the order of insertion of the values 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 false. Continued increments return a value equal to false until reset() is called.

Synopsis

 #include<rw/tvdlist.h>
 RWTValDlist<T,A> dl;
 RWTValDlistIterator<T,A> itr(dl);

Persistence

None

Examples

 #include<rw/tvdlist.h>
 #include<iostream>
 #include<rw/cstring.h>
 int main() {
    RWTValDlist<RWCString> a;
    RWTValDlistIterator<RWCString> itr(a);
 
    a.insert("John");
    a.insert("Steve");
    a.insert("Mark");
    a.insert("Steve");
 
    while(itr()) {
      std::cout << itr.key() << std::endl;
    }
 
    return 0;
 }

Program Output:

 John
 Steve
 Mark
 Steve

---

Constructor & Destructor Documentation

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

RWTValDlistIterator< T, A >::RWTValDlistIterator

(

RWTValDlist< T, A > &

s

)

[inline]

Creates an iterator for the dlist s. 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 >>

RWTValDlist<T ,A >* RWTValDlistIterator< T, A >::container

(

)

const [inline]

Returns a pointer to the collection being iterated over.

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

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

Advances self to the first element t encountered by iterating forward such that the expression ((*fn)(t,d)) is true. Returns true if an element was found, otherwise returns false. Client data may be passed through parameter d.

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

bool RWTValDlistIterator< T, A >::findNext

(

const T &

a

)

Advances self to the first element t encountered by iterating forward, such that the expression (t == a) is true. Returns true if an element was found, otherwise returns false.

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

T& RWTValDlistIterator< T, A >::key

(

)

const [inline]

Returns a reference to the stored value.

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

bool RWTValDlistIterator< T, A >::operator()

(

void

)

[inline]

Advances self to the next element and returns its value. If the iterator has advanced past the last item in the container, returns rwnil.

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

bool RWTValDlistIterator< 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 false is returned. Otherwise, returns true.

Note:

No post-increment operator is provided.

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

bool RWTValDlistIterator< 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 >>

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

(

)

Moves self back to the immediately previous element. If the iterator has been reset or just created, this operator returns false, otherwise it returns 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 RWTValDlistIterator< 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 >>

bool RWTValDlistIterator< T, A >::remove

(

)

Removes the value referenced by self from the collection. Returns true if the removal is successful, otherwise false.

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

bool RWTValDlistIterator< T, A >::removeNext	(	bool(*)(const T &, void *)	fn,
		void *	d
	)

Removes the first element t, encountered by iterating self forward, such that the expression ((*fn)(t,d)) is true. Returns true if an element was found and removed, otherwise returns false. Client data may be passed through parameter d.

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

bool RWTValDlistIterator< T, A >::removeNext

(

const T &

a

)

Removes the first element t, encountered by iterating self forward, such that the expression (t == a) is true. Returns true if an element was found and removed, otherwise returns false.

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

void RWTValDlistIterator< T, A >::reset

(

RWTValDlist< T, A > &

l

)

[inline]

Resets the iterator so that after being advanced, it references the first element of the collection l.

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

void RWTValDlistIterator< T, A >::reset

(

void

)

[inline]

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