Member Function Documentation

iterator::iterator()

Constructs an uninitialized iterator.

Functions like operator*() and operator++() should not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.

See also Qt3D::QCircularBuffer::begin() and Qt3D::QCircularBuffer::end().

bool iterator::operator!=(const iterator & other) const

Returns true if other points to a different item than this iterator; otherwise returns false.

See also operator==().

T & iterator::operator*() const

Returns a modifiable reference to the current item.

You can change the value of an item by using operator*() on the left side of an assignment.

See also operator->().

iterator iterator::operator+(int j) const

Returns an iterator to the item at j positions forward from this iterator. (If j is negative, the iterator goes backward.)

See also operator-() and operator+=().

iterator & iterator::operator++()

The prefix ++ operator (++it) advances the iterator to the next item in the circular buffer and returns an iterator to the new current item.

Calling this function on Qt3D::QCircularBuffer::end() leads to undefined results.

See also operator--().

iterator iterator::operator++(int)

This is an overloaded function.

The postfix ++ operator (it++) advances the iterator to the next item in the circular buffer and returns an iterator to the previously current item.

iterator & iterator::operator+=(int j)

Advances the iterator by j items. (If j is negative, the iterator goes backward.)

See also operator-=() and operator+().

iterator iterator::operator-(int j) const

Returns an iterator to the item at j positions backward from this iterator. (If j is negative, the iterator goes forward.)

See also operator+() and operator-=().

int iterator::operator-(iterator other) const

Returns the number of items between the item pointed to by other and the item pointed to by this iterator.

iterator & iterator::operator--()

The prefix -- operator (--it) makes the preceding item the current item, and returns an iterator to the new current item.

Calling this function on Qt3D::QCircularBuffer::begin() leads to undefined results.

See also operator++().

iterator iterator::operator--(int)

This is an overloaded function.

The postfix -- operator (it--) makes the preceding item the current item, and returns an iterator to the previously current item.

iterator & iterator::operator-=(int j)

Makes the iterator go back by j items. (If j is negative, the iterator goes forward.)

See also operator+=() and operator-().

T * iterator::operator->() const

Returns a pointer to the current item.

See also operator*().

bool iterator::operator<(const iterator & other) const

Returns true if the item pointed to by this iterator occurs before the item pointed to by the other iterator.

bool iterator::operator<=(const iterator & other) const

Returns true if the item pointed to by this iterator occurs before or at the same position as the item pointed to by the other iterator.

bool iterator::operator==(const iterator & other) const

Returns true if other points to the same item as this iterator; otherwise returns false.

See also operator!=().

bool iterator::operator>(const iterator & other) const

Returns true if the item pointed to by this iterator occurs after the item pointed to by the other iterator.

bool iterator::operator>=(const iterator & other) const

Returns true if the item pointed to by this iterator occurs after or at the same position as the item pointed to by the other iterator.

T & iterator::operator[](int j) const

Returns a modifiable reference to the item at position *this + j.

This function is provided to make QCircularBuffer iterators behave like C++ pointers.

See also operator+().