Click on the banner to return to the Class Reference home page.

©Copyright 1996 Rogue Wave Software

RWTPtrSlistIterator<T>

• Synopsis
• Please Note!
• Description
• Persistence
• Examples
• Public Constructors
• Public Member Operators
• Public Member Functions

#include<rw/tpslist.h>

RWTPtrSlist<T> dl;
RWTPtrSlistIterator<T> itr(dl);

RWTPtrSlistIterator is supplied with Tools 7 to provide an iterator interface to the new Standard Library based collections that has backward compatibility with the container iterators provided in Tools 6.

The order of iteration over an RWTPtrSlist is dependent upon the order of insertion of items into 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 preincrement 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.

None

#include<rw/tpslist.h>

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

int main(){

   RWTPtrSlist<RWCString> a;
   RWTPtrSlistIterator<RWCString> itr(a);
   a.insert(new RWCString("John"));
   a.insert(new RWCString("Steve"));
   a.insert(new RWCString("Mark"));
   a.insert(new RWCString("Steve"));

   for(;itr();)

     cout << *itr.key() <<endl;

   return 0;

}

Program Output
John
Steve
Mark
Steve

RWTPtrSlistIterator<T>(RWTPtrSlist<T>& lst);

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

T*
operator()();

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, the element returned will be a nil pointer equivalent to boolean false.

RWBoolean
operator++();

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 list, self will now reference an undefined value distinct from the reset value and a value equivalent to false will be returned. Otherwise, a value equivalent to true is returned. Note: no post-increment operator is provided.

RWBoolean
operator+=(size_type n);

Behaves as if the operator++ member function had been applied n times

RWTPtrSlist<T>*
container() const;

Returns a pointer to the collection being iterated over.

T*
findNext(const T* a);

Returns the first element t encountered by iterating self forward, such that the expression (*t == *a) is true. If no such element is found, returns nil. Leaves self referencing the found item or "off the end."

T*
findNext(RWBoolean(*fn)(T*, void*), void* d);

Returns the first element t encountered by iterating self forward such that the expression((*fn)(t,d)) is true. fn points to a user-defined tester function which must have prototype:

   bool yourTester(const T* a, void* d);

Client data may be passed through parameter d.

void
insertAfterPoint(T* p);

Inserts the pointer p into the container directly after the element pointed to by self. Leaves self referencing the prior item, or in reset condition.

T*
key();

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

T*
remove();

Returns the stored value pointed to by self. and removes it from the collection. Undefined if self is not referencing a value within the list. Leaves self referencing the prior item, or in reset condition.

T*
removeNext(const T*);

Returns and removes the first element t, encountered by iterating self forward, such that the expression (*t == *a) is true. Leaves self referencing the prior item, or in reset condition.

T*
removeNext(RWBoolean(*fn)(T*, void*), void* d);

Returns and removes the first element t, encountered by iterating self forward, such that the expression((*fn)(t,d)) is true. fn points to a user-defined tester function which must have prototype:

   bool yourTester(const T* a, void* d);

Client data may be passed through parameter d. Leaves self referencing the prior item, or in reset condition.

void
reset();
void
reset(RWTPtrSlist<T>& l);

Resets the iterator so that after being advanced it will reference the first element of the collection. Using reset() with no argument will reset the iterator on the current container. Supplying a RWTPtrSlist to reset() will reset the iterator on the new container.