shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt > Class Template Reference

#include <list_edge_model.h>

Collaboration diagram for shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >:

[legend]

List of all members.

Public Types
typedef AbstractIteratorHelper < NodeType >	base_type
Public Member Functions
	ListIteratorHelper (const ListEdgeModel &lm, EdgeModel::CommunicationDirection dir, NodeType &n, NodeHoodIt s, NodeHoodIt e)
virtual	~ListIteratorHelper ()
virtual void	init (void) throw ()
	Skips to the first/next node that is reachable by the communication direction.
virtual void	next (void) throw ()
	Skips to the next node that is reachable by the communication direction.
virtual NodeType *	current (void) const throw ()
	Returns the current neighboring node or NULL if the end has been reached.
virtual AbstractIteratorHelper < NodeType > *	clone (void) const throw ()

---

Detailed Description

template<typename NodeType, typename NodeHoodIt>
class shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >

Iterator helper used by the edge model to iterate over neighborhoods.

---

Member Typedef Documentation

template<typename NodeType, typename NodeHoodIt>

typedef AbstractIteratorHelper<NodeType> shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >::base_type

---

Constructor & Destructor Documentation

template<typename NodeType, typename NodeHoodIt>

shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >::ListIteratorHelper	(	const ListEdgeModel &	lm,
		EdgeModel::CommunicationDirection	dir,
		NodeType &	n,
		NodeHoodIt	s,
		NodeHoodIt	e
	)

Creates a new iterator helper instance for use with the EdgeModel

Parameters:

	lm	The list model that created this iterator helper
	dir	Communication direction that this iterator will deliver
	n	The node of which the neighbors shall be returned
	s	The start iterator of the list edge models internal data structure containing the complete node neighborhood
	e	The end iterator of the list edge models internal data structure containing the complete node neighborhood

template<typename NodeType, typename NodeHoodIt>

virtual shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >::~ListIteratorHelper

(

)

[virtual]

---

Member Function Documentation

template<typename NodeType, typename NodeHoodIt>

virtual void shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >::init

(

void

)

throw () [virtual]

Skips to the first/next node that is reachable by the communication direction.

template<typename NodeType, typename NodeHoodIt>

virtual void shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >::next

(

void

)

throw () [virtual]

Skips to the next node that is reachable by the communication direction.

template<typename NodeType, typename NodeHoodIt>

virtual NodeType* shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >::current

(

void

)

const throw () [virtual]

Returns the current neighboring node or NULL if the end has been reached.

template<typename NodeType, typename NodeHoodIt>

virtual AbstractIteratorHelper<NodeType>* shawn::ListEdgeModel::ListIteratorHelper< NodeType, NodeHoodIt >::clone

(

void

)

const throw () [virtual]

---

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

• src/sys/edge_models/list_edge_model.h