Proto  3.2
Public Member Functions | Private Attributes | List of all members
Proto::SideIterator Class Reference

Side Iterator. More...

#include <Proto_Face.H>

Public Member Functions

 SideIterator (int a_start=0)
 Constructor. More...
 
 ~SideIterator ()
 Destructor. More...
 
void begin ()
 Begin. More...
 
void operator++ ()
 Increment. More...
 
bool operator== (const SideIterator &a_iter)
 Equality Operator. More...
 
bool operator!= (const SideIterator &a_iter)
 Inequality Operator. More...
 
Side::LoHiSide operator* ()
 Dereference. More...
 
Side::LoHiSide operator() () const
 Get Value. More...
 
bool ok () const
 Continue Query. More...
 

Private Attributes

int m_current
 

Detailed Description

Side Iterator.

Convenience iterator to allow iteration through Lo, Hi.

Constructor & Destructor Documentation

◆ SideIterator()

Proto::SideIterator::SideIterator ( int  a_start = 0)
inline

Constructor.

◆ ~SideIterator()

Proto::SideIterator::~SideIterator ( )
inline

Destructor.

Member Function Documentation

◆ begin()

void Proto::SideIterator::begin ( )
inline

Begin.

Set the iterator to the first side.

◆ operator++()

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

Increment.

Advance the iterator to the next face.

◆ operator==()

bool Proto::SideIterator::operator== ( const SideIterator a_iter)
inline

Equality Operator.

References m_current.

◆ operator!=()

bool Proto::SideIterator::operator!= ( const SideIterator a_iter)
inline

Inequality Operator.

References m_current.

◆ operator*()

Side::LoHiSide Proto::SideIterator::operator* ( )
inline

Dereference.

◆ operator()()

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

Get Value.

Returns the current Side

References Proto::Side::Hi, Proto::Side::Invalid, and Proto::Side::Lo.

◆ ok()

bool Proto::SideIterator::ok ( ) const
inline

Continue Query.

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

References Proto::Side::NUMSIDES.

Member Data Documentation

◆ m_current

int Proto::SideIterator::m_current
private

Referenced by operator!=(), and operator==().


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