Proto::SideIterator Class Reference

Iterator for low and high side. More...

#include <Proto_LoHiSide.H>

Public Member Functions
	SideIterator ()
	~SideIterator ()
Modification functions
void	begin ()
void	reset ()
void	next ()
void	operator++ ()

Access functions
Side::LoHiSide	operator() () const
bool	ok () const

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()

Proto::SideIterator::SideIterator ( )

inline

Default, and only, constructor.

~SideIterator()

Proto::SideIterator::~SideIterator ( )

inline

Default destructor.

Member Function Documentation

begin()

void Proto::SideIterator::begin ( )

inline

Set the iterator to the first side.

next()

void Proto::SideIterator::next ( )

inline

Advance the iterator to the next face.

ok()

bool Proto::SideIterator::ok ( ) const

inline

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

operator()()

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

inline

Returns the value of the side for the current iteration.

operator++()

void Proto::SideIterator::operator++ ( )

inline

Advance the iterator to the next face.

reset()

void Proto::SideIterator::reset ( )

inline

Set the iterator to the first side.

---

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

• /home/doxygen/proto/include/Proto_LoHiSide.H