Index   Main   Namespaces   Classes   Hierarchy   Annotated   Files   Compound   Global   Pages  
Public Member Functions

SgNbIterator Class Reference

Iterate over all on-board neighbor points. More...

#include <SgBoardConst.h>

Inheritance diagram for SgNbIterator:
Inheritance graph
[legend]

List of all members.

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.

Detailed Description

Iterate over all on-board neighbor points.

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

Definition at line 327 of file SgBoardConst.h.


Constructor & Destructor Documentation

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

Definition at line 334 of file SgBoardConst.h.


Member Function Documentation

SgPointIterator::operator bool (  )  const [inherited]

Return true if iteration is valid, otherwise false.

Definition at line 60 of file SgPointIterator.h.

References SgPointIterator::m_point, and SG_ENDPOINT.

SgPoint SgPointIterator::operator* (  )  const [inherited]

Return the value of the current element.

Definition at line 55 of file SgPointIterator.h.

References SgPointIterator::m_point.

void SgPointIterator::operator++ (  )  [inherited]

Advance the state of the iteration to the next element.

Definition at line 50 of file SgPointIterator.h.

References SgPointIterator::m_point.


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


Sun Mar 13 2011 Doxygen 1.7.1