RWTPtrSetConstIterator< T, C, A > Class Template Reference

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

#include <rw/tpset.h>

Public Member Functions
	RWTPtrSetConstIterator (const RWTPtrSet< T, C, A > &s)
	RWTPtrSetConstIterator (const RWTPtrSetIterator< T, C, A > &itr)
const RWTPtrSet< T, C, A > *	container () const
const T *	key () const
const T *	operator() ()
bool	operator++ ()
void	reset ()
void	reset (const RWTPtrSet< T, C, A > &t)

Detailed Description

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

Deprecated

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

RWTPtrSetConstIterator provides a const iterator interface to C++ Standard Library-based RWTPtrSet collections. A const iterator does not modify any information in the underlying data structure.

The order of iteration over an RWTPtrSet is dependent on the comparator object supplied 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/tpset.h>
template <class T, class C, class A = std::allocator<T*> >
class RWTPtrSetConstIterator

Persistence

None

Constructor & Destructor Documentation

RWTPtrSetConstIterator() [1/2]

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

RWTPtrSetConstIterator< T, C, A >::RWTPtrSetConstIterator ( const RWTPtrSet< T, C, A > & s )

inline

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

RWTPtrSetConstIterator() [2/2]

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

RWTPtrSetConstIterator< T, C, A >::RWTPtrSetConstIterator ( const RWTPtrSetIterator< 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

container()

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

const RWTPtrSet< T, C, A > * RWTPtrSetConstIterator< T, C, A >::container ( ) const

inline

Returns a pointer to the collection being iterated over.

key()

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

const T * RWTPtrSetConstIterator< T, C, A >::key ( ) const

inline

Returns the stored value pointed to by self. Undefined if self is not referencing a value within the set.

operator()()

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

const T * RWTPtrSetConstIterator< T, C, A >::operator() ( )

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 will be returned.

operator++()

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

bool RWTPtrSetConstIterator< T, C, A >::operator++ ( )

inline

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 set, self now references an undefined value and a value equivalent to false is returned. Otherwise, a value equivalent to true is returned.

reset() [1/2]

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

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

inline

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

reset() [2/2]

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

void RWTPtrSetConstIterator< T, C, A >::reset ( const RWTPtrSet< T, C, A > & t )

inline

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