RWTPtrMultiSetIterator< T, C, A > Class Template Reference

Deprecated. Provides an iterator for RWTPtrMultiSet. More...

#include <rw/tpmset.h>

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

Friends
class	RWTPtrMultiSetConstIterator< T, C, A >

Detailed Description

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

Deprecated

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

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

The order of iteration over an RWTPtrMultiSet is dependent upon 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/tpmset.h>
RWTPtrMultiSet<T, C, A> set;
RWTPtrMultiSetIterator<T, C, A> itr(set);

Persistence

None

Example

#include <rw/cstring.h>
#include <rw/tpmset.h>
#include <iostream>
 
int main() {
  RWTPtrMultiSet<RWCString, std::less<RWCString> > a;
  RWTPtrMultiSetIterator<RWCString, std::less<RWCString> > itr(a);
 
  a.insert(new RWCString("John"));
  a.insert(new RWCString("Steve"));
  a.insert(new RWCString("Mark"));
  a.insert(new RWCString("Steve"));
 
  while (itr()) {
    std::cout << *itr.key() << std::endl;
  }
 
  a.clearAndDestroy();
  return 0;
}

Program Output:

John
Mark
Steve
Steve

Constructor & Destructor Documentation

RWTPtrMultiSetIterator()

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

RWTPtrMultiSetIterator< T, C, A >::RWTPtrMultiSetIterator ( RWTPtrMultiSet< T, C, A > & m )

inline

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

Member Function Documentation

container()

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

RWTPtrMultiSet< T, C, A > * RWTPtrMultiSetIterator< 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*>>

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

inline

Returns the stored value referenced by self. Undefined if self is not referencing a value within the list.

operator()()

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

T * RWTPtrMultiSetIterator< 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 RWTPtrMultiSetIterator< 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 multiset, self will now point to an undefined value, and a value equivalent to false will be 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 RWTPtrMultiSetIterator< T, C, A >::reset ( )

inline

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

reset() [2/2]

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

void RWTPtrMultiSetIterator< T, C, A >::reset ( RWTPtrMultiSet< T, C, A > & t )

inline

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