NotifyEngineWrite.h File Reference

NotifyEngineWrite is a general wrapper class that is used to tell an engine that we're going to write to it. More...

#include "Utilities/WrappedInt.h"

Include dependency graph for NotifyEngineWrite.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	NotifyEngineWrite< Engine >
	NotifyEngineWrite is a general wrapper class that is used to tell an engine that we're going to write to it. More...
Functions
template<class Engine >
void	notifyEngineWrite (const Engine &e)
	This helper function simplifies use of the NotifyEngineWrite functor.
template<class Engine >
void	notifyEngineWrite (const Engine &, const WrappedInt< false > &)
	This function lets us skip the notification at compile time.
template<class Engine >
void	notifyEngineWrite (const Engine &e, const WrappedInt< true > &)
	This function lets us skip the notification at compile time.

---

Detailed Description

NotifyEngineWrite is a general wrapper class that is used to tell an engine that we're going to write to it.

---

Function Documentation

template<class Engine >

void notifyEngineWrite

(

const Engine &

e

)

[inline]

This helper function simplifies use of the NotifyEngineWrite functor.

References NotifyEngineWrite< Engine >::notify().

Referenced by Evaluator< MainEvaluatorTag >::evaluate(), PatchEvaluator< MainEvaluatorTag >::evaluate(), ParticleEvaluator::evaluate(), PatchEvaluator< MainEvaluatorTag >::evaluate2(), ParticleEvaluator::evaluate2(), ParticleEvaluator::evaluate2Block(), PatchEvaluator< MainEvaluatorTag >::evaluate3(), ParticleEvaluator::evaluate3(), ParticleEvaluator::evaluate3Block(), ParticleEvaluator::evaluateBlock(), Evaluator< MainEvaluatorTag >::evaluateZeroBased(), and EngineWriteNotifier::operator()().

template<class Engine >

void notifyEngineWrite	(	const Engine &	,
		const WrappedInt< false > &
	)		[inline]

This function lets us skip the notification at compile time.

(If we're actually reading from the engine, for example.)

template<class Engine >

void notifyEngineWrite	(	const Engine &	e,
		const WrappedInt< true > &
	)		[inline]

This function lets us skip the notification at compile time.

(If we're actually reading from the engine, for example.)

References NotifyEngineWrite< Engine >::notify().