grail::utility::Consideration< ContextType > Class Template Reference

The Consideration class - Abstract type of Evaluator representing a subset of game state. More...

#include <Consideration.hh>

Inheritance diagram for grail::utility::Consideration< ContextType >:

Collaboration diagram for grail::utility::Consideration< ContextType >:

Public Member Functions
	Consideration (const Consideration< ContextType > &)=default
	Consideration (Consideration< ContextType > &&)=default
Consideration &	operator= (const Consideration< ContextType > &)=default
Consideration &	operator= (Consideration< ContextType > &&)=default
virtual EvaluatorType	GetEvaluatorType () const override final
virtual std::string	GetDisplayName () const
Public Member Functions inherited from grail::utility::Evaluator< ContextType >
float	EvaluateContext (const ContextType &context, UtilityEvaluatorSnapshot *const snapshot) const
	EvaluateContext - evaluates provided context and if provided snapshot is not empty, fills it with debug data describing this node. More...

Protected Member Functions
virtual float	Evaluate (const ContextType &context) const =0
	Evaluate - Abstract method, which should be overriden by the user to return proper value representing desirable subset of game state. More...
virtual void	DebugDump (const std::map< const void *, std::size_t > &, EvaluationDebugData &debugData) const override final
	DebugDump - Called from EvaluateContext, which generates additional debug data for each evaluator. Should be overriden in each derived evaluator to better reflect debug tree topology. More...
virtual float	Evaluate (const ContextType &context, UtilityEvaluatorSnapshot *const snapshot) const override final
	Evaluate - Called from EvaluateContext which also evaluates context, but without automatically filling snapshot with debug data. Should be overriden for each derived Evaluator. More...

Detailed Description

template<typename ContextType>
class grail::utility::Consideration< ContextType >

The Consideration class - Abstract type of Evaluator representing a subset of game state.

Template Parameters

ContextType

- Type of evaluated object. By default - ValueTuple(AIEntity, Blackboard).

Member Function Documentation

DebugDump()

template<typename ContextType >

virtual void grail::utility::Consideration< ContextType >::DebugDump ( const std::map< const void *, std::size_t > &  nodeMapping, EvaluationDebugData &  debugData  ) const

inlinefinaloverrideprotectedvirtual

DebugDump - Called from EvaluateContext, which generates additional debug data for each evaluator. Should be overriden in each derived evaluator to better reflect debug tree topology.

Parameters

nodeMapping	- Maps node pointers to node index.
debugData	- Evaluation debug data which will be filled in this method

Implements grail::utility::Evaluator< ContextType >.

Evaluate() [1/2]

template<typename ContextType >

virtual float grail::utility::Consideration< ContextType >::Evaluate ( const ContextType &  context ) const

protectedpure virtual

Evaluate - Abstract method, which should be overriden by the user to return proper value representing desirable subset of game state.

Parameters

context

- Object from which user can calculate desirable subset of game state.

Returns

Value representing subset of game state.

Evaluate() [2/2]

template<typename ContextType >

virtual float grail::utility::Consideration< ContextType >::Evaluate ( const ContextType &  context, UtilityEvaluatorSnapshot *const  snapshot  ) const

inlinefinaloverrideprotectedvirtual

Evaluate - Called from EvaluateContext which also evaluates context, but without automatically filling snapshot with debug data. Should be overriden for each derived Evaluator.

Parameters

context	- Input data for evaluation.
snapshot	- Evaluator snapshot containing debug data describing whole evaluator tree.

Returns

Numerical evaluation of provided context.

Implements grail::utility::Evaluator< ContextType >.

---

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

• GrailEvaluators/Consideration.hh