AVxcelerate Simulation Framework 2024 R1

simulation_framework::evaluator::IEvaluator Class Reference

Last update: 16.07.2025

class IEvaluator More...

#include <i_evaluator.h>

Inheritance diagram for simulation_framework::evaluator::IEvaluator:
Inheritance graph
[legend]

Public Member Functions

virtual void Init ()=0
 
virtual void Reset ()=0
 
virtual void Evaluate ()=0
 
virtual void AddKpi (kpi::IKpiPtr kpi)=0
 
virtual kpi::KpiMessage GetKpiMessage () const =0
 
virtual void SetGroundTruth (const avx_osi3::GroundTruth &ground_truth)=0
 

Detailed Description

class IEvaluator

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

Member Function Documentation

◆ 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.

◆ Evaluate()

virtual void simulation_framework::evaluator::IEvaluator::Evaluate ( )
pure virtual

Do calculation of all KPIs

Implemented in simulation_framework::evaluator::BaseEvaluator.

◆ GetKpiMessage()

virtual kpi::KpiMessage simulation_framework::evaluator::IEvaluator::GetKpiMessage ( ) const
pure virtual

Get the filled KPI messages based on calculation of all KPIs

Returns
A kpi::KpiMessage object, the vector of KpiContent represents of all added KPIs into this evaluator

Implemented in simulation_framework::evaluator::BaseEvaluator.

◆ Init()

virtual void simulation_framework::evaluator::IEvaluator::Init ( )
pure virtual

Implement any initialization related logic happens here

Implemented in simulation_framework::evaluator::BaseEvaluator.

◆ Reset()

virtual void simulation_framework::evaluator::IEvaluator::Reset ( )
pure virtual

Implement any logic to reset your KPI calculations

Implemented in simulation_framework::evaluator::BaseEvaluator.

◆ SetGroundTruth()

virtual void simulation_framework::evaluator::IEvaluator::SetGroundTruth ( const avx_osi3::GroundTruth &  ground_truth)
pure virtual

Set GroundTruth message for KPI calculations

Parameters
ground_truthThe osi groundtruth type in protobuf

Implemented in simulation_framework::evaluator::BaseEvaluator.

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

Connect with Ansys