ThunderEgg::Face< D, M >::Range::Iterator Class Reference

Input iterator for Side values. More...

#include <Face.h>

Inheritance diagram for ThunderEgg::Face< D, M >::Range::Iterator:

Collaboration diagram for ThunderEgg::Face< D, M >::Range::Iterator:

Public Member Functions
	Iterator (Face< D, M > s)
	Construct a new Iterator object with the given Side value. More...
const Face< D, M > &	operator++ ()
	Increment the side value. More...
const Face< D, M > &	operator* () const
	Get a reference to the side object. More...
const Face< D, M > *	operator-> () const
	Get a pointer to the side object. More...
bool	operator== (const Iterator &b) const
	Check the iterators reference the same value. More...
bool	operator!= (const Iterator &b) const
	Check the iterators don't reference the same value. More...

Detailed Description

template<int D, int M>
class ThunderEgg::Face< D, M >::Range::Iterator

Input iterator for Side values.

Constructor & Destructor Documentation

Iterator()

template<int D, int M>

ThunderEgg::Face< D, M >::Range::Iterator::Iterator ( Face< D, M >  s )

inlineexplicit

Construct a new Iterator object with the given Side value.

Parameters

s_in

the side

Member Function Documentation

operator!=()

template<int D, int M>

bool ThunderEgg::Face< D, M >::Range::Iterator::operator!= ( const Iterator &  b ) const

inline

Check the iterators don't reference the same value.

Parameters

b	the other iterator

Returns

true if different

false if the same

operator*()

template<int D, int M>

const Face<D, M>& ThunderEgg::Face< D, M >::Range::Iterator::operator* ( ) const

inline

Get a reference to the side object.

Returns

const Face<D,M>& the reference

operator++()

template<int D, int M>

const Face<D, M>& ThunderEgg::Face< D, M >::Range::Iterator::operator++ ( )

inline

Increment the side value.

Returns

const Face<D,M>& the resulting value

operator->()

template<int D, int M>

const Face<D, M>* ThunderEgg::Face< D, M >::Range::Iterator::operator-> ( ) const

inline

Get a pointer to the side object.

Returns

const Face<D,M>* the pointer

operator==()

template<int D, int M>

bool ThunderEgg::Face< D, M >::Range::Iterator::operator== ( const Iterator &  b ) const

inline

Check the iterators reference the same value.

Parameters

b	the other iterator

Returns

true if the same

false if different

---

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

• src/ThunderEgg/Face.h