RWTValSetConstIterator< T, C, A > Class Template Reference

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

#include <rw/tvset.h>

Public Member Functions
	RWTValSetConstIterator (const RWTValSet< T, C, A > &s)
	RWTValSetConstIterator (const RWTValSetIterator< T, C, A > &itr)
const RWTValSet< T, C, A > *	container () const
const T &	key () const
bool	operator() ()
bool	operator++ ()
void	reset ()
void	reset (const RWTValSet< T, C, A > &s)

Detailed Description

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

Deprecated

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

RWTValSetConstIterator provides a const iterator for class RWTValSet. A const iterator prohibits changes to the collection over which it is iterating.

The order of iteration over an RWTValSet is dependent on the supplied 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/tvset.h>
RWTValSet<T, C, A> vs;
RWTValSetConstIterator<T, C, A> itr(vs);

Persistence

None

Constructor & Destructor Documentation

RWTValSetConstIterator() [1/2]

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

RWTValSetConstIterator< T, C, A >::RWTValSetConstIterator ( const RWTValSet< 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.

RWTValSetConstIterator() [2/2]

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

RWTValSetConstIterator< T, C, A >::RWTValSetConstIterator ( const RWTValSetIterator< 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 RWTValSet< T, C, A > * RWTValSetConstIterator< 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 & RWTValSetConstIterator< T, C, A >::key ( ) const

inline

Returns the value referenced by self.

operator()()

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

bool RWTValSetConstIterator< T, C, A >::operator() ( )

inline

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

operator++()

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

bool RWTValSetConstIterator< 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 false is returned. Otherwise, returns true.

reset() [1/2]

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

void RWTValSetConstIterator< T, C, 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 C = std::less<T>, class A = std::allocator<T>>

void RWTValSetConstIterator< T, C, A >::reset ( const RWTValSet< T, C, A > & s )

inline

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