Loris::Partial_ConstIterator Class Reference

Const iterator for the Loris::Partial Breakpoint map. More...

#include <Partial.h>

List of all members.

Public Member Functions
	Partial_ConstIterator (void)
	Construct a new iterator referring to no position in any Partial.
	Partial_ConstIterator (const Partial_Iterator &other)
	Construct a new const iterator from a non-const iterator.
Partial_ConstIterator &	operator++ ()
	Pre-increment operator - advance the position of the iterator and return the iterator itself.
Partial_ConstIterator &	operator-- ()
	Pre-decrement operator - move the position of the iterator back by one and return the iterator itself.
Partial_ConstIterator	operator++ (int)
	Post-increment operator - advance the position of the iterator and return a copy of the iterator before it was advanced.
Partial_ConstIterator	operator-- (int)
	Post-decrement operator - move the position of the iterator back by one and return a copy of the iterator before it was decremented.
const Breakpoint &	operator * (void) const
	Dereference operator.
const Breakpoint *	operator-> (void) const
	Pointer operator.
const Breakpoint &	breakpoint (void) const
	Breakpoint accessor.
double	time (void) const
	Time accessor.
Friends
bool	operator== (const Partial_ConstIterator &lhs, const Partial_ConstIterator &rhs)
	Equality comparison operator.
bool	operator!= (const Partial_ConstIterator &lhs, const Partial_ConstIterator &rhs)
	Inequality comparison operator.

---

Detailed Description

Const iterator for the Loris::Partial Breakpoint map.

Wraps the non-const iterator for the (time,Breakpoint) pair container Partial::container_type. Partial_Iterator implements a bidirectional iterator interface, and additionally offers time and Breakpoint (reference) access through time() and breakpoint() members.

---

Constructor & Destructor Documentation

Loris::Partial_ConstIterator::Partial_ConstIterator (  const Partial_Iterator &  other  )

Construct a new const iterator from a non-const iterator. Parameters: other  a non-const iterator from which to make a read-only copy.

---

Member Function Documentation

const Breakpoint& Loris::Partial_ConstIterator::breakpoint (  void   )  const

Breakpoint accessor. Returns: A const reference to the Breakpoint at the position of this iterator.

const Breakpoint& Loris::Partial_ConstIterator::operator * (  void   )  const

Dereference operator. Returns: A const reference to the Breakpoint at the position of this iterator.

Partial_ConstIterator Loris::Partial_ConstIterator::operator++ (  int   )

Post-increment operator - advance the position of the iterator and return a copy of the iterator before it was advanced. The int argument is unused compiler magic. Returns: An iterator that is a copy of this iterator before being advanced. Precondition: The iterator must be a valid position before the end in some Partial.

Partial_ConstIterator& Loris::Partial_ConstIterator::operator++ (   )

Pre-increment operator - advance the position of the iterator and return the iterator itself. Returns: This iterator (reference to self). Precondition: The iterator must be a valid position before the end in some Partial.

Partial_ConstIterator Loris::Partial_ConstIterator::operator-- (  int   )

Post-decrement operator - move the position of the iterator back by one and return a copy of the iterator before it was decremented. The int argument is unused compiler magic. Returns: An iterator that is a copy of this iterator before being decremented. Precondition: The iterator must be a valid position after the beginning in some Partial.

Partial_ConstIterator& Loris::Partial_ConstIterator::operator-- (   )

Pre-decrement operator - move the position of the iterator back by one and return the iterator itself. Returns: This iterator (reference to self). Precondition: The iterator must be a valid position after the beginning in some Partial.

const Breakpoint* Loris::Partial_ConstIterator::operator-> (  void   )  const

Pointer operator. Returns: A const pointer to the Breakpoint at the position of this iterator.

double Loris::Partial_ConstIterator::time (  void   )  const

Time accessor. Returns: The time in seconds of the Breakpoint at the position of this iterator.

---

Friends And Related Function Documentation

bool operator!= (  const Partial_ConstIterator &  lhs, const Partial_ConstIterator &  rhs )  [friend]

Inequality comparison operator. Parameters: lhs  the iterator on the left side of the operator. rhs  the iterator on the right side of the operator. Returns: false if the two iterators refer to the same position in the same Partial, true otherwise.

bool operator== (  const Partial_ConstIterator &  lhs, const Partial_ConstIterator &  rhs )  [friend]

Equality comparison operator. Parameters: lhs  the iterator on the left side of the operator. rhs  the iterator on the right side of the operator. Returns: true if the two iterators refer to the same position in the same Partial, false otherwise.

---