Loris::Partial_ConstIterator Class Reference

#include <Partial.h>

List of all members.

Public Types
typedef BaseIterator::iterator_category	iterator_category
typedef Breakpoint	value_type
typedef BaseIterator::difference_type	difference_type
typedef const Breakpoint *	pointer
typedef const Breakpoint &	reference
Public Member Functions
	Partial_ConstIterator (void)
	Partial_ConstIterator (const Partial_Iterator &other)
Partial_ConstIterator &	operator++ ()
Partial_ConstIterator &	operator-- ()
Partial_ConstIterator	operator++ (int)
Partial_ConstIterator	operator-- (int)
const Breakpoint &	operator* (void) const
const Breakpoint *	operator-> (void) const
const Breakpoint &	breakpoint (void) const
double	time (void) const
Friends
class	Partial
bool	operator== (const Partial_ConstIterator &lhs, const Partial_ConstIterator &rhs)
bool	operator!= (const Partial_ConstIterator &lhs, const Partial_ConstIterator &rhs)

---

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.

---

Member Typedef Documentation

typedef BaseIterator::difference_type Loris::Partial_ConstIterator::difference_type

The type representing the distance between two of these iterators.

typedef BaseIterator::iterator_category Loris::Partial_ConstIterator::iterator_category

The iterator category, for copmpatibility with C++ standard library algorithms

typedef const Breakpoint* Loris::Partial_ConstIterator::pointer

The type of a pointer to the type of element that can be accessed through this iterator (const Breakpoint *).

typedef const Breakpoint& Loris::Partial_ConstIterator::reference

The type of a reference to the type of element that can be accessed through this iterator (const Breakpoint &).

typedef Breakpoint Loris::Partial_ConstIterator::value_type

The type of element that can be accessed through this iterator (Breakpoint).

---

Constructor & Destructor Documentation

Loris::Partial_ConstIterator::Partial_ConstIterator

(

void

)

[inline]

Construct a new iterator referring to no position in any Partial.

Loris::Partial_ConstIterator::Partial_ConstIterator

(

const Partial_Iterator &

other

)

[inline]

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 [inline]

Breakpoint accessor.

Returns:

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

const Breakpoint& Loris::Partial_ConstIterator::operator*

(

void

)

const [inline]

Dereference operator.

Returns:

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

Partial_ConstIterator Loris::Partial_ConstIterator::operator++

(

int

)

[inline]

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++

(

)

[inline]

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

)

[inline]

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--

(

)

[inline]

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 [inline]

Pointer operator.

Returns:

A const pointer to the Breakpoint at the position of this iterator.

double Loris::Partial_ConstIterator::time

(

void

)

const [inline]

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.

---

The documentation for this class was generated from the following file:

• /Users/kfitz/Projects/Loris/Loris development/src/Partial.h