RWTValSlistIterator< T, A > Class Template Reference

Deprecated. Provides an iterator for RWTValSlist. More...

#include <rw/tvslist.h>

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

Detailed Description

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

Deprecated:

As of SourcePro 12.5, use RWTValSlist::iterator to iterate over the elements in this collection.

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

The order of iteration over an RWTValSlist 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.

The value type must have operator== and operator< defined. This requirement is imposed by the C++ Standard Library.

Synopsis

#include <rw/tvslist.h>
RWTValSlist<T,A> dl;
RWTValSlistIterator<T,A> itr(dl);

Persistence

None

Example

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

int main() {
   RWTValSlist<RWCString> a;
   RWTValSlistIterator<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>>

RWTValSlistIterator< T, A >::RWTValSlistIterator ( RWTValSlist< T, A > &  s )

inline

Creates an iterator for the singly linked list 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>>

RWTValSlist<T, A>* RWTValSlistIterator< T, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

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

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

bool RWTValSlistIterator< 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. Client data may be passed through parameter d. Returns true if an element was found, otherwise returns false.

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

void RWTValSlistIterator< T, A >::insertAfterPoint

(

const 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& RWTValSlistIterator< T, A >::key ( ) const

inline

Returns a reference to the stored value.

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

bool RWTValSlistIterator< T, A >::operator() ( void  )

inline

Advances self to the next element and returns true. If the iterator has advanced past the last element in the collection, returns false.

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

bool RWTValSlistIterator< 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 the operator returns false. Otherwise, returns true.

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

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

bool RWTValSlistIterator< 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. Client data may be passed through parameter d. Returns true if an element was found and removed, otherwise returns false.

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

void RWTValSlistIterator< T, A >::reset ( void  )

inline

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

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

void RWTValSlistIterator< T, A >::reset ( RWTValSlist< T, A > &  l )

inline

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