RWTPtrDlistIterator<T>

• Data Type and Member Function Indexes
• Synopsis
• Please Note!
• Description
• Persistence
• Example
• Public Constructors
• Public Member Operators
• Public Member Functions

Member Functions
container() findNext() insertAfterPoint() key() operator()() operator++()	operator+=() operator--() operator-=() remove() removeNext() reset()

#include<rw/tpdlist.h>
RWTPtrDlist<T> dl;
RWTPtrDlistIterator<T> itr(dl);

RWTPtrDlistIterator provides an iterator interface to the Tools 7 Standard C++ Library-based collections which is compatible with the iterator interface provided for the Tools.h++ 6.xcontainers.

The order of iteration over an RWTPtrDlist is dependent on the order of the values 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 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. For operator--, decrementing past the first element will return a value equivalent to false.

None

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

int main(){
   RWTPtrDlist<RWCString> a;
   RWTPtrDlistIterator<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

RWTPtrDlistIterator<T>(RWTPtrDlist<T>& l); 

Creates an iterator for the list l. 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 reference the first element. If, before iteration, self referenced the last value in the list, self will now referece 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 operator++() had been applied n times

RWBoolean
operator--();

Moves self back to the immediately previous element. If the iterator has been reset or just created, this operator will return a value equivalent to false, otherwise it will return a value equivalent to true. If self references the the first element, it will now be in the reset state. If self has been iterated past the last value in the list, it will now reference the last item in the list. Note: no post-decrement operator is provided.

RWBoolean
operator-=(size_type n); 

Behaves as if operator--() had been applied n times

RWTPtrDlist<T>*
container() const; 

Returns a pointer to the collection being iterated over.

T*
findNext(const T* a); 

Returns the first element t encountered while iterating self forward, such that the expression (*t == *a) is true. If no such element exists, returns a nil pointer equivalent to false. Leaves self referencing the found item, or "past 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. If no such element exists, returns a nil pointer equivalent to false. Leaves self referencing the found item, or "past the end."

void
insertAfterPoint(T* p); 

Inserts the pointer p into the container directly after the element referenced by self.

T*
key();

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

T*
remove();

Returns the stored value referenced by self and removes it from the collection. Undefined if self is not referencing a value within the list.

T*
removeNext(const T*);

Returns and removes the first element t, encountered by iterating self forward, such that the expression (*t == *a) is true. If no such element exists, returns nil.

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. If no such element exists, returns nil.

void
reset();
void
reset(RWTPtrDlist<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 RWTPtrDlist<T> to reset() will reset the iterator on the new container.