Loris::Partial_Iterator 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 Breakpoint *	pointer
typedef Breakpoint &	reference
Public Member Functions
	Partial_Iterator (void)
Partial_Iterator &	operator++ ()
Partial_Iterator &	operator-- ()
Partial_Iterator	operator++ (int)
Partial_Iterator	operator-- (int)
Breakpoint &	operator* (void) const
Breakpoint *	operator-> (void) const
Breakpoint &	breakpoint (void) const
double	time (void) const
Friends
class	Partial
class	Partial_ConstIterator
bool	operator== (const Partial_Iterator &lhs, const Partial_Iterator &rhs)
bool	operator!= (const Partial_Iterator &lhs, const Partial_Iterator &rhs)

---

Detailed Description

Non-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_Iterator::difference_type

The type representing the distance between two of these iterators.

typedef BaseIterator::iterator_category Loris::Partial_Iterator::iterator_category

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

typedef Breakpoint* Loris::Partial_Iterator::pointer

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

typedef Breakpoint& Loris::Partial_Iterator::reference

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

typedef Breakpoint Loris::Partial_Iterator::value_type

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

---

Constructor & Destructor Documentation

Loris::Partial_Iterator::Partial_Iterator

(

void

)

[inline]

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

---

Member Function Documentation

Breakpoint& Loris::Partial_Iterator::breakpoint

(

void

)

const [inline]

Breakpoint accessor.

Returns:

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

Breakpoint& Loris::Partial_Iterator::operator*

(

void

)

const [inline]

Dereference operator.

Returns:

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

Partial_Iterator Loris::Partial_Iterator::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_Iterator& Loris::Partial_Iterator::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_Iterator Loris::Partial_Iterator::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_Iterator& Loris::Partial_Iterator::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.

Breakpoint* Loris::Partial_Iterator::operator->

(

void

)

const [inline]

Dereference operator.

Returns:

A reference to the Breakpoint at the position of this iterator. Pointer operator.

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

double Loris::Partial_Iterator::time

(

void

)

const [inline]

Breakpoint accessor.

Returns:

A reference to the Breakpoint at the position of this iterator. Time accessor.

The time in seconds of the Breakpoint at the position of this iterator.

---

Friends And Related Function Documentation

bool operator!=	(	const Partial_Iterator &	lhs,
		const Partial_Iterator &	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_Iterator &	lhs,
		const Partial_Iterator &	rhs
	)			[friend]

Pointer operator.

Returns:

A pointer to the Breakpoint at the position of this iterator. 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