Custom Edge list const iterator class, which returns only const Edge pointers. This iterator cannot be used to change the structure of its list without access to that list directly. Customized since STL's const-iterator cannot be prevented from giving non-const access to its data. The former workaround to this problem was to define two sets of edge lists on each vertex: a list< Edge * > and a list< Edge const * >. More...

#include <Graph.hh>

Collaboration diagram for core::graph::EdgeListConstIterator:

[legend]

Public Member Functions
	EdgeListConstIterator ()
	default constructor, owner and element set to null More...

	EdgeListConstIterator (EdgeList const *owner)
	owner constructor More...

	EdgeListConstIterator (EdgeList const owner, EdgeListElement const element)
	owner and element constructor: points at a position in a list More...

	EdgeListConstIterator (EdgeListConstIterator const &src)
	copy constructor More...

	EdgeListConstIterator (EdgeListIterator const &src)
	const-cast constructor More...

	~EdgeListConstIterator ()
	non-virtual destructor, does nothing More...

EdgeListConstIterator const &	operator= (EdgeListConstIterator const &rhs)
	assignmnet operator More...

EdgeListConstIterator const &	operator++ ()
	increment operator. Point this iterator at the next element in the list. More...

EdgeListConstIterator const &	operator-- ()
	decrement operator. Point this iterator at the previous element in the list. More...

bool	operator== (EdgeListConstIterator const &rhs) const
	equality operator. Do these elements point at the same list element? Asserts that they belong to the same list. Never compare elements from separate lists. More...

bool	operator== (EdgeListIterator const &rhs) const
	const-cast equality operator. Do these elements point at the same list element? Asserts that they belong to the same list. Never compare elements from separate lists. More...

bool	operator!= (EdgeListConstIterator const &rhs) const
	inequality operator. Do these elements point to different elements from the same list? Asserts that they belong to the same list. Never compare elements from separate lists. Elements need not be valid to be compared. More...

bool	operator!= (EdgeListIterator const &rhs) const
	const-cast inequality operator. Do these elements point to different elements from the same list? Asserts that they belong to the same list. Never compare elements from separate lists. Elements need not be valid to be compared. More...

Edge const *	operator* () const
	dereference operator: return the edge pointer pointed to by the list element this iterator is hovering over. This method returns a const edge pointer, which defines this class as a const iterator. There are no methods, of course, to access the list element itself. More...

Edge const &	operator-> () const
	dereference operator: return the edge pointer pointed to by the list element this iterator is hovering over. This method returns a const edge pointer, which defines this class as a const iterator. There are no methods, of course, to access the list element itself. More...

bool	valid () const
	Is this a valid iterator? More...

Private Attributes
EdgeList const *	owner_

EdgeListElement const *	element_

Friends
class	EdgeList

Detailed Description

Custom Edge list const iterator class, which returns only const Edge pointers. This iterator cannot be used to change the structure of its list without access to that list directly. Customized since STL's const-iterator cannot be prevented from giving non-const access to its data. The former workaround to this problem was to define two sets of edge lists on each vertex: a list< Edge * > and a list< Edge const * >.

Definition at line 227 of file Graph.hh.

Constructor & Destructor Documentation

core::graph::EdgeListConstIterator::EdgeListConstIterator ( )

inline

default constructor, owner and element set to null

Definition at line 232 of file Graph.hh.

core::graph::EdgeListConstIterator::EdgeListConstIterator ( EdgeList const * owner)

inline

owner constructor

Definition at line 236 of file Graph.hh.

core::graph::EdgeListConstIterator::EdgeListConstIterator	(	EdgeList const *	owner,
		EdgeListElement const *	element
	)

inline

owner and element constructor: points at a position in a list

Definition at line 240 of file Graph.hh.

core::graph::EdgeListConstIterator::EdgeListConstIterator ( EdgeListConstIterator const & src)

inline

copy constructor

Definition at line 244 of file Graph.hh.

core::graph::EdgeListConstIterator::EdgeListConstIterator ( EdgeListIterator const & src)

inline

const-cast constructor

Definition at line 248 of file Graph.hh.

core::graph::EdgeListConstIterator::~EdgeListConstIterator ( )

inline

non-virtual destructor, does nothing

Definition at line 253 of file Graph.hh.

Member Function Documentation

bool core::graph::EdgeListConstIterator::operator!= ( EdgeListConstIterator const & rhs) const

inline

inequality operator. Do these elements point to different elements from the same list? Asserts that they belong to the same list. Never compare elements from separate lists. Elements need not be valid to be compared.

Definition at line 294 of file Graph.hh.

References operator==().

bool core::graph::EdgeListConstIterator::operator!= ( EdgeListIterator const & rhs) const

inline

const-cast inequality operator. Do these elements point to different elements from the same list? Asserts that they belong to the same list. Never compare elements from separate lists. Elements need not be valid to be compared.

Definition at line 302 of file Graph.hh.

References operator==().

Edge const* core::graph::EdgeListConstIterator::operator* ( ) const

inline

dereference operator: return the edge pointer pointed to by the list element this iterator is hovering over. This method returns a const edge pointer, which defines this class as a const iterator. There are no methods, of course, to access the list element itself.

Definition at line 309 of file Graph.hh.

References core::graph::EdgeListElement::const_edge(), element_, and valid().

EdgeListConstIterator const& core::graph::EdgeListConstIterator::operator++ ( )

inline

increment operator. Point this iterator at the next element in the list.

Definition at line 265 of file Graph.hh.

References core::graph::EdgeListElement::const_next(), element_, and valid().

EdgeListConstIterator const& core::graph::EdgeListConstIterator::operator-- ( )

inline

decrement operator. Point this iterator at the previous element in the list.

Definition at line 270 of file Graph.hh.

References core::graph::EdgeListElement::const_previous(), element_, and valid().

Edge const& core::graph::EdgeListConstIterator::operator-> ( ) const

inline

dereference operator: return the edge pointer pointed to by the list element this iterator is hovering over. This method returns a const edge pointer, which defines this class as a const iterator. There are no methods, of course, to access the list element itself.

Definition at line 315 of file Graph.hh.

References core::graph::EdgeListElement::const_edge(), element_, and valid().

EdgeListConstIterator const& core::graph::EdgeListConstIterator::operator= ( EdgeListConstIterator const & rhs)

inline

assignmnet operator

Definition at line 256 of file Graph.hh.

References element_, and owner_.

bool core::graph::EdgeListConstIterator::operator== ( EdgeListConstIterator const & rhs) const

inline

equality operator. Do these elements point at the same list element? Asserts that they belong to the same list. Never compare elements from separate lists.

Definition at line 276 of file Graph.hh.

References element_, and owner_.

Referenced by operator!=().

bool core::graph::EdgeListConstIterator::operator== ( EdgeListIterator const & rhs) const

inline

const-cast equality operator. Do these elements point at the same list element? Asserts that they belong to the same list. Never compare elements from separate lists.

Definition at line 284 of file Graph.hh.

References core::graph::EdgeListIterator::element_, element_, core::graph::EdgeListIterator::owner_, and owner_.

bool core::graph::EdgeListConstIterator::valid ( ) const

inline

Is this a valid iterator?

Definition at line 880 of file Graph.hh.

References element_, core::graph::EdgeList::is_end_element(), and owner_.

Referenced by operator*(), operator++(), operator--(), and operator->().