RWTPtrSlistConstIterator<T,A>

Module:  Essential Tools Module   Group:  STL Extension-based Collection Classes

Does not inherit

• Local Index
• Synopsis
• Description
• Persistence
• Public Constructors
• Public Member Operators
• Public Member Functions

Members

container() findNext()

key() operator()()

operator++() operator+=()

reset() RWTPtrSlistConstIterator<T,A>()

#include <rw/tpslist.h>
template <class T, class A=std::allocator<T*> > class
RWTPtrSlistConstIterator

RWTPtrSlistConstIterator provides a const iterator interface to standard library-based RWTPtrSlist collections. A const iterator does not change anything in the data structure it iterates over.

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 returns a value equivalent to boolean false. Continued increments return a value equivalent to false until reset() is called.

None

RWTPtrSlistConstIterator<T,A>(RWTPtrSlist<T,A>& lst);

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

const 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 is a nil pointer equivalent to boolean false.

bool
operator++();

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

bool
operator+=(size_type n); 

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

const RWTPtrSlist<T,A>*
container() const; 

Returns a pointer to the collection being iterated over.

const 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."

const T*
findNext(bool(*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.

const T*
key();

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

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

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

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.