RWTPtrSetIterator< T, C, A > Class Template Reference

Deprecated. Provides an iterator for RWTPtrSet. More...

#include <rw/tpset.h>

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

Detailed Description

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

Deprecated:

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

RWTPtrSetIterator provides an iterator interface to the C++ Standard Library-based collection represented by RWTPtrSet. (An STL iterator interface is provided through RWTPtrSet::iterator.)

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 will return a value equivalent to boolean false. Continued increments will 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>
RWTPtrSet<T,C,A> set;
RWTPtrSetIterator<T,C,A> itr(set);

Persistence

None

Example

#include <rw/tpset.h>
#include <iostream>
#include <rw/cstring.h>

int main() {
   RWTPtrSet<RWCString,std::less<RWCString> > a;
   RWTPtrSetIterator<RWCString,std::less<RWCString> > itr(a);

   a.insert(new RWCString("John"));
   a.insert(new RWCString("Steve"));
   a.insert(new RWCString("Mark"));

   while(itr()) {
     std::cout << *itr.key() <<  std::endl;
   }

   a.clearAndDestroy();
   return 0;
}

Program Output

John
Mark
Steve

Constructor & Destructor Documentation

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

RWTPtrSetIterator< T, C, A >::RWTPtrSetIterator ( RWTPtrSet< T, C, A > &  t )

inline

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

Member Function Documentation

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

RWTPtrSet<T, C, A>* RWTPtrSetIterator< 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*>>

T* RWTPtrSetIterator< 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.

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

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

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

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

inline

Advances self to the next element. If the iterator has been reset or just created, self will now reference the first element. If, before iteration, self referenced the last association in the set, self will now reference an undefined value, and a value equivalent to false will be returned. Otherwise, a value equivalent to true is returned.

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

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

inline

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

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

void RWTPtrSetIterator< T, C, A >::reset ( 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.