## On this page

  

 

 # simulation\_framework::evaluator::IEvaluator Class Reference

 Last update: 16.07.2025 

class [IEvaluator](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml "class IEvaluator") [More...](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml#details)

`#include <<a class="el" href="i__evaluator_8h_source.xhtml">i_evaluator.h</a>>`

Inheritance diagram for simulation_framework::evaluator::IEvaluator:

![Inheritance graph](/sites/default/files/migrate-content/avxcelerate_simulation_framework_2024_r1/classsimulation__framework_1_1evaluator_1_1IEvaluator__inherit__graph.png)

\[[legend](graph_legend.xhtml)\]

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

virtual void [Init](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml#afda42274ea5a6cbf100dd37c75c18ad1) ()=0 virtual void [Reset](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml#a7de1d24ee59889bdde8a3920db7b9a8e) ()=0 virtual void [Evaluate](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml#ad57b87c746be02f976f6446355adba0f) ()=0 virtual void [AddKpi](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml#a0ce6030014428862f9045b23646a979a) (kpi::IKpiPtr kpi)=0 virtual kpi::KpiMessage [GetKpiMessage](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml#ab0f3c91ae7570b0316536ad935347f29) () const =0 virtual void [SetGroundTruth](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml#a7c9ad6bc77c910ee07a46575d92c95fa) (const avx\_osi3::GroundTruth &amp;ground\_truth)=0 <a id="details" name="details"></a>## Detailed Description

class [IEvaluator](classsimulation__framework_1_1evaluator_1_1IEvaluator.xhtml "class IEvaluator")

Interface definition for evaluator where user can add KPIs and do evaluations in a chain based on GroundTruth message



## Member Function Documentation

<a id="a0ce6030014428862f9045b23646a979a"></a>## [◆ ](#a0ce6030014428862f9045b23646a979a)AddKpi()

 virtual void simulation\_framework::evaluator::IEvaluator::AddKpi  ( kpi::IKpiPtr  *kpi*)   pure virtual 

Add one KPI into this evaluator

Parameters kpiiKpi interface Implemented in [simulation\_framework::evaluator::BaseEvaluator](classsimulation__framework_1_1evaluator_1_1BaseEvaluator.xhtml#ab4b009e8c649215e9efa0538a26e5434).





<a id="ad57b87c746be02f976f6446355adba0f"></a>## [◆ ](#ad57b87c746be02f976f6446355adba0f)Evaluate()

 virtual void simulation\_framework::evaluator::IEvaluator::Evaluate  ( )   pure virtual 

Do calculation of all KPIs

Implemented in [simulation\_framework::evaluator::BaseEvaluator](classsimulation__framework_1_1evaluator_1_1BaseEvaluator.xhtml#a6fb2ef47d7255c49aee0c8a469b8fd1a).





<a id="ab0f3c91ae7570b0316536ad935347f29"></a>## [◆ ](#ab0f3c91ae7570b0316536ad935347f29)GetKpiMessage()

 virtual kpi::KpiMessage simulation\_framework::evaluator::IEvaluator::GetKpiMessage  ( )  const  pure virtual 

Get the filled KPI messages based on calculation of all KPIs

ReturnsA kpi::KpiMessage object, the vector of KpiContent represents of all added KPIs into this evaluator Implemented in [simulation\_framework::evaluator::BaseEvaluator](classsimulation__framework_1_1evaluator_1_1BaseEvaluator.xhtml#a71c2d66129809f394b74069a92649b7d).





<a id="afda42274ea5a6cbf100dd37c75c18ad1"></a>## [◆ ](#afda42274ea5a6cbf100dd37c75c18ad1)Init()

 virtual void simulation\_framework::evaluator::IEvaluator::Init  ( )   pure virtual 

Implement any initialization related logic happens here

Implemented in [simulation\_framework::evaluator::BaseEvaluator](classsimulation__framework_1_1evaluator_1_1BaseEvaluator.xhtml#a2c79b6267cc4da10eabdc7f87a648e48).





<a id="a7de1d24ee59889bdde8a3920db7b9a8e"></a>## [◆ ](#a7de1d24ee59889bdde8a3920db7b9a8e)Reset()

 virtual void simulation\_framework::evaluator::IEvaluator::Reset  ( )   pure virtual 

Implement any logic to reset your KPI calculations

Implemented in [simulation\_framework::evaluator::BaseEvaluator](classsimulation__framework_1_1evaluator_1_1BaseEvaluator.xhtml#a688d826f7112e8f8f6561e6ebaeb6a09).





<a id="a7c9ad6bc77c910ee07a46575d92c95fa"></a>## [◆ ](#a7c9ad6bc77c910ee07a46575d92c95fa)SetGroundTruth()

 virtual void simulation\_framework::evaluator::IEvaluator::SetGroundTruth  ( const avx\_osi3::GroundTruth &amp;  *ground\_truth*)   pure virtual 

Set GroundTruth message for KPI calculations

Parameters ground\_truthThe osi groundtruth type in protobuf Implemented in [simulation\_framework::evaluator::BaseEvaluator](classsimulation__framework_1_1evaluator_1_1BaseEvaluator.xhtml#a042e972003ab591146f202d580c73b21).





---

The documentation for this class was generated from the following file:- [i\_evaluator.h](i__evaluator_8h_source.xhtml)