SideIterator Class Reference

Iterator for low and high side. More...

#include <LoHiSide.H>

List of all members.

Access functions
Side::LoHiSide	operator() () const
bool	ok () const
Public Member Functions
	SideIterator ()
	~SideIterator ()
Modification functions
void	begin ()
void	reset ()
void	next ()
void	operator++ ()

---

Detailed Description

Iterator for low and high side.

SideIterator iterates over the values Side::Lo and Side::Hi. There are no adjustable parameters whatsoever.

---

Constructor & Destructor Documentation

SideIterator::SideIterator (   )

Default, and only, constructor.

SideIterator::~SideIterator (   )  [inline]

Default destructor.

---

Member Function Documentation

void SideIterator::begin (   )

Set the iterator to the first side.

void SideIterator::next (   )

Advance the iterator to the next face.

bool SideIterator::ok (   )  const

Returns true if there is a next side, false if not.

Side::LoHiSide SideIterator::operator() (   )  const

Returns the value of the side for the current iteration.

void SideIterator::operator++ (   )

Advance the iterator to the next face.

void SideIterator::reset (   )  [inline]

Set the iterator to the first side.

---

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

• LoHiSide.H

---