CeresEngine::MeshGenerator::Iterator< Generator > Class Template Reference

An iterator that can be used to "drive" a generator. More...

#include <CeresEngine/Mesh/Generator/Iterator.hpp>

Public Types
using	value_type = typename GeneratedType< Generator >::Type
using	difference_type = std::ptrdiff_t
using	pointer = value_type *
using	reference = value_type &

Public Member Functions
	Iterator () noexcept
	Creates a dummy end iterator.
	Iterator (Generator &generator) noexcept
	Iterator to the given generator.
Iterator &	operator++ ()
	Advance the iterator.
const Iterator::value_type &	operator* () const
	Get reference to the current generated value.
const Iterator::value_type *	operator-> () const
	Get pointer to the current generated value.
bool	operator== (const Iterator &that) const noexcept
	Iterators are equal if both are out of range or both iterate the same generator.
bool	operator!= (const Iterator &that) const noexcept

Private Attributes
Generator *	mGenerator
GeneratedType< Generator >::Type	value_

Detailed Description

template<typename Generator>
class CeresEngine::MeshGenerator::Iterator< Generator >

An iterator that can be used to "drive" a generator.

Note that iterator mutates the generator.

Member Typedef Documentation

difference_type

template<typename Generator >

using CeresEngine::MeshGenerator::Iterator< Generator >::difference_type = std::ptrdiff_t

pointer

template<typename Generator >

using CeresEngine::MeshGenerator::Iterator< Generator >::pointer = value_type*

reference

template<typename Generator >

using CeresEngine::MeshGenerator::Iterator< Generator >::reference = value_type&

value_type

template<typename Generator >

using CeresEngine::MeshGenerator::Iterator< Generator >::value_type = typename GeneratedType<Generator>::Type

Constructor & Destructor Documentation

Iterator() [1/2]

template<typename Generator >

CeresEngine::MeshGenerator::Iterator< Generator >::Iterator ( )

inlinenoexcept

Creates a dummy end iterator.

Iterator() [2/2]

template<typename Generator >

CeresEngine::MeshGenerator::Iterator< Generator >::Iterator ( Generator &  generator )

inlinenoexcept

Iterator to the given generator.

Member Function Documentation

operator!=()

template<typename Generator >

bool CeresEngine::MeshGenerator::Iterator< Generator >::operator!= ( const Iterator< Generator > &  that ) const

inlinenoexcept

operator*()

template<typename Generator >

const Iterator::value_type & CeresEngine::MeshGenerator::Iterator< Generator >::operator* ( ) const

inline

Get reference to the current generated value.

Exceptions

std::out_of_range

If the iterator is out of range.

operator++()

template<typename Generator >

Iterator & CeresEngine::MeshGenerator::Iterator< Generator >::operator++ ( )

inline

Advance the iterator.

Might make the iterator "out of range".

Exceptions

std::out_of_range

If the iterator is out of range.

operator->()

template<typename Generator >

const Iterator::value_type * CeresEngine::MeshGenerator::Iterator< Generator >::operator-> ( ) const

inline

Get pointer to the current generated value.

Exceptions

std::out_of_range

If the iterator is out of range

operator==()

template<typename Generator >

bool CeresEngine::MeshGenerator::Iterator< Generator >::operator== ( const Iterator< Generator > &  that ) const

inlinenoexcept

Iterators are equal if both are out of range or both iterate the same generator.

Member Data Documentation

mGenerator

template<typename Generator >

Generator* CeresEngine::MeshGenerator::Iterator< Generator >::mGenerator

private

value_

template<typename Generator >

GeneratedType<Generator>::Type CeresEngine::MeshGenerator::Iterator< Generator >::value_

private

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Mesh/Generator/Iterator.hpp