CopperSpice API  1.7.2
QMutableVectorIterator< T > Class Template Reference

Java style iterator for QVector and QStack. More...

Public Methods

 QMutableVectorIterator (QVector< T > &vector)
 
bool findNext (const T &value)
 
bool findPrevious (const T &value)
 
bool hasNext () const
 
bool hasPrevious () const
 
void insert (const T &value)
 
T & next ()
 
QMutableVectorIterator & operator= (QVector< T > &vector)
 
T & peekNext () const
 
T & peekPrevious () const
 
T & previous ()
 
void remove ()
 
void setValue (const T &value) const
 
void toBack ()
 
void toFront ()
 
T & value ()
 
const T & value () const
 

Detailed Description

template<class T>
class QMutableVectorIterator< T >

The QMutableVectorIterator class provides a Java style iterator for QVector and QStack. For more information refer to Java style iterators.

See also
QVectorIterator, QVector::iterator

Constructor & Destructor Documentation

template<class T >
QMutableVectorIterator< T >::QMutableVectorIterator ( QVector< T > &  vector)
inline

Constructs an iterator for traversing vector. The iterator is set to be at the front of the vector (before the first item).

See also
operator=()

Method Documentation

template<class T >
bool QMutableVectorIterator< T >::findNext ( const T &  value)
inline

Searches for value starting from the current iterator position forward. Returns true if value is found, otherwise returns false.

After the call, if value was found, the iterator is positioned just after the matching item, otherwise the iterator is positioned at the back of the container.

See also
findPrevious()
template<class T >
bool QMutableVectorIterator< T >::findPrevious ( const T &  value)
inline

Searches for value starting from the current iterator position backward. Returns true if value is found, otherwise returns false.

After the call, if value was found, the iterator is positioned just before the matching item, otherwise the iterator is positioned at the front of the container.

See also
findNext()
template<class T >
bool QMutableVectorIterator< T >::hasNext ( ) const
inline

Returns true if there is at least one item ahead of the iterator, i.e. the iterator is not at the back of the container, otherwise returns false.

See also
hasPrevious(), next()
template<class T >
bool QMutableVectorIterator< T >::hasPrevious ( ) const
inline

Returns true if there is at least one item behind the iterator, i.e. the iterator is not at the front of the container, otherwise returns false.

See also
hasNext(), previous()
template<class T >
void QMutableVectorIterator< T >::insert ( const T &  value)
inline

Inserts value at the current iterator position. After the call, the iterator is located just after the inserted item.

See also
remove(), setValue()
template<class T >
T & QMutableVectorIterator< T >::next ( )
inline

Returns a reference to the next item, and advances the iterator by one position.

Calling this function on an iterator located at the back of the container leads to undefined behavior.

See also
hasNext(), peekNext(), previous()
template<class T >
QMutableVectorIterator & QMutableVectorIterator< T >::operator= ( QVector< T > &  vector)
inline

Makes the iterator operate on vector. The iterator is set to be at the front of the vector (before the first item).

See also
toFront(), toBack()
template<class T >
T & QMutableVectorIterator< T >::peekNext ( ) const
inline

Returns a reference to the next item, without moving the iterator.

Calling this function on an iterator located at the back of the container leads to undefined behavior.

See also
hasNext(), next(), peekPrevious()
template<class T >
T & QMutableVectorIterator< T >::peekPrevious ( ) const
inline

Returns a reference to the previous item, without moving the iterator.

Calling this function on an iterator located at the front of the container leads to undefined behavior.

See also
hasPrevious(), previous(), peekNext()
template<class T >
T & QMutableVectorIterator< T >::previous ( )
inline

Returns a reference to the previous item and moves the iterator back by one position.

Calling this function on an iterator located at the front of the container leads to undefined behavior.

See also
hasPrevious(), peekPrevious(), next()
template<class T >
void QMutableVectorIterator< T >::remove ( )
inline

Removes the last item that was jumped over using one of the traversal functions (next(), previous(), findNext(), findPrevious()).

Example:

while (iter.hasNext()) {
int val = iter.next();
if (val < -32768 || val > 32767) {
iter.remove();
}
}
See also
insert(), setValue()
template<class T >
void QMutableVectorIterator< T >::setValue ( const T &  value) const
inline

Replaces the value of the last item that was jumped over using one of the traversal functions with value.

The traversal functions are next(), previous(), findNext(), and findPrevious().

Example:

while (iter.hasNext()) {
double val = iter.next();
iter.setValue(sqrt(val));
}
See also
value(), remove(), insert()
template<class T >
void QMutableVectorIterator< T >::toBack ( )
inline

Moves the iterator to the back of the container (after the last item).

See also
toFront(), previous()
template<class T >
void QMutableVectorIterator< T >::toFront ( )
inline

Moves the iterator to the front of the container (before the first item).

See also
toBack(), next()
template<class T >
T & QMutableVectorIterator< T >::value ( )
inline

Returns a non-const reference to the value of the last item that was jumped over using one of the traversal functions.

template<class T >
const T & QMutableVectorIterator< T >::value ( ) const
inline

Returns the value of the last item that was jumped over using one of the traversal functions (next(), previous(), findNext(), findPrevious()).

After a call to next() or findNext(), value() is equivalent to peekPrevious(). After a call to previous() or findPrevious(), value() is equivalent to peekNext().

See also
setValue()