SgNbIterator Class Reference

#include <SgBoardConst.h>

Inheritance diagram for SgNbIterator:

[legend]List of all members.

---

Detailed Description

Iterate over all on-board neighbor points.

The points are iterated in sorted order (from low to high).

Definition at line 340 of file SgBoardConst.h.

Public Member Functions
	SgNbIterator (const SgBoardConst &boardConst, SgPoint p)
void	operator++ ()
	Advance the state of the iteration to the next element.
SgPoint	operator * () const
	Return the value of the current element.
	operator bool () const
	Return true if iteration is valid, otherwise false.

---

Constructor & Destructor Documentation

SgNbIterator::SgNbIterator	(	const SgBoardConst &	boardConst,
		SgPoint	p
	)

Definition at line 347 of file SgBoardConst.h.

---

Member Function Documentation

SgPoint SgPointIterator::operator *

(

)

const [inherited]

Return the value of the current element.

Definition at line 57 of file SgPointIterator.h.

References SgPointIterator::m_point.

SgPointIterator::operator bool

(

)

const [inherited]

Return true if iteration is valid, otherwise false.

Definition at line 62 of file SgPointIterator.h.

References SgPointIterator::m_point, and SG_ENDPOINT.

void SgPointIterator::operator++

(

)

[inherited]

Advance the state of the iteration to the next element.

Definition at line 52 of file SgPointIterator.h.

References SgPointIterator::m_point.

---

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

• SgBoardConst.h

---

17 Jun 2010 Doxygen 1.4.7