RWTValSlistConstIterator< T, A > Class Template Reference

Deprecated. Provides a const iterator for RWTValSlist. More...

#include <rw/tvslist.h>

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

Detailed Description

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

Deprecated

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

RWTValSlistConstIterator provides a const iterator interface for RWTValSlist. A const iterator prohibits any changes to the collection over which it iterates.

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 boolean 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>
template <class T, class A = std::allocator<T> >
class RWTValSlistConstIterator

Persistence

None

Constructor & Destructor Documentation

RWTValSlistConstIterator() [1/2]

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

RWTValSlistConstIterator< T, A >::RWTValSlistConstIterator ( const RWTValSlist< T, A > & s )

inline

Creates a const iterator for the singly linked list s. The iterator begins in an undefined state and must be advanced before the first element is accessible.

RWTValSlistConstIterator() [2/2]

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

RWTValSlistConstIterator< T, A >::RWTValSlistConstIterator ( const RWTValSlistIterator< T, A > & itr )

inline

Creates a const iterator from the iterator itr. The const iterator begins in an undefined state and must be advanced before the first element is accessible.

Member Function Documentation

container()

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

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

inline

Returns a pointer to the collection being iterated over.

findNext() [1/2]

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

bool RWTValSlistConstIterator< T, A >::findNext	(	bool(*	fn )(const T &, void *),
		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.

findNext() [2/2]

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

bool RWTValSlistConstIterator< 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.

key()

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

const T & RWTValSlistConstIterator< T, A >::key ( ) const

inline

Returns the stored value referenced by self.

operator()()

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

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

inline

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

operator++()

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

bool RWTValSlistConstIterator< 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.

operator+=()

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

bool RWTValSlistConstIterator< T, A >::operator+=

(

size_t

n

)

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

reset() [1/2]

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

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

inline

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

reset() [2/2]

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

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

inline

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