RWTValDlistConstIterator< T, A > Class Template Reference

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

#include <rw/tvdlist.h>

Public Member Functions
	RWTValDlistConstIterator (const RWTValDlist< T, A > &s)
	RWTValDlistConstIterator (const RWTValDlistIterator< T, A > &itr)
const RWTValDlist< 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)
bool	operator-- ()
bool	operator-= (size_t n)
void	reset ()
void	reset (const RWTValDlist< T, A > &l)

Detailed Description

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

Deprecated

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

RWTValDlistConstIterator provides a const iterator for Standard Library-based RWTValDlist collections. The const iterator prohibits changes to the underlying collection.

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

Synopsis

#include <rw/tvdlist.h>
template <class T, class A = std::allocator<T> >
class RWTValDlistConstIterator

Persistence

None

Constructor & Destructor Documentation

RWTValDlistConstIterator() [1/2]

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

RWTValDlistConstIterator< T, A >::RWTValDlistConstIterator ( const 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.

RWTValDlistConstIterator() [2/2]

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

RWTValDlistConstIterator< T, A >::RWTValDlistConstIterator ( const RWTValDlistIterator< T, A > & itr )

inline

Creates an 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 RWTValDlist< T, A > * RWTValDlistConstIterator< 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 RWTValDlistConstIterator< 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. Returns true if an element was found, otherwise false. Client data may be passed through parameter d.

findNext() [2/2]

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

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

inline

Returns the stored value referenced by self.

operator()()

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

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

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.

operator++()

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

bool RWTValDlistConstIterator< T, A >::operator++

(

)

Advances self to the next element. If the iterator has been reset or just created, self now 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 this operator returns false. Otherwise, returns true.

operator+=()

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

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

(

size_t

n

)

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

operator--()

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

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

(

)

Moves self back to the immediately previous element. If the iterator has been reset or just created, returns false, otherwise it returns true. If self now references the first element, it is now in the reset state. If self has been iterated past the last value in the list, it now references the last item in the list.

operator-=()

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

bool RWTValDlistConstIterator< 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 RWTValDlistConstIterator< 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 RWTValDlistConstIterator< T, A >::reset ( const RWTValDlist< T, A > & l )

inline

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