RWTPtrSortedDlistConstIterator< T, C, A > Class Template Reference

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

#include <rw/tpsrtdli.h>

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

Detailed Description

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

Deprecated:

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

RWTPtrSortedDlistConstIterator provides a const iterator interface to C++ Standard Library-based RWTPtrSortedDlist collections. A const iterator does not modify anything in the underlying collection.

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 returns a value equivalent to boolean false. Continued increments 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>
template <class T, class C, class A=std::allocator<T*> > class
RWTPtrSortedDlistConstIterator

Persistence

None

Constructor & Destructor Documentation

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

RWTPtrSortedDlistConstIterator< T, C, A >::RWTPtrSortedDlistConstIterator ( const RWTPtrSortedDlist< T, C, A > &  l )

inline

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

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

RWTPtrSortedDlistConstIterator< T, C, A >::RWTPtrSortedDlistConstIterator ( const RWTPtrSortedDlistIterator< T, C, 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

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

const RWTPtrSortedDlist<T, C, A>* RWTPtrSortedDlistConstIterator< T, C, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

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

const T* RWTPtrSortedDlistConstIterator< 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 = std::less<T>, class A = std::allocator<T*>>

const T* RWTPtrSortedDlistConstIterator< 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 = std::less<T>, class A = std::allocator<T*>>

const T* RWTPtrSortedDlistConstIterator< 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 = std::less<T>, class A = std::allocator<T*>>

const T* RWTPtrSortedDlistConstIterator< 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 is returned.

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

bool RWTPtrSortedDlistConstIterator< T, C, 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 association in the list, self now points to an undefined value and a value equivalent to false is returned. Otherwise, a value equivalent to true is returned.

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

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

(

size_t

n

)

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

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

bool RWTPtrSortedDlistConstIterator< T, C, 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 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.

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

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

(

size_t

n

)

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

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

void RWTPtrSortedDlistConstIterator< T, C, A >::reset ( void  )

inline

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

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

void RWTPtrSortedDlistConstIterator< T, C, A >::reset ( const RWTPtrSortedDlist< T, C, A > &  l )

inline

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