Skip to main content

AVxcelerate Simulation Framework 2024 R1

simulation_framework::evaluator::kpi::IKpi Class Reference

Last update: 16.07.2025

class IKpi More...

#include <i_kpi.h>

Inheritance diagram for simulation_framework::evaluator::kpi::IKpi:

Public Member Functions

virtual void Init ()=0
 
virtual void Reset ()=0
 
virtual KpiContent CalculateKpi (const avx_osi3::GroundTruth &ground_truth)=0
 
virtual kpi::Type GetKpiType () const =0
 Return the KPI type, currently three types are possible: kpi::Type::kScalar, The KPI is scalar value with unit kpi::Type::kTimeSeries, The KPI is a time serie kpi::Type::kLog, The KPI is part of a continuous log.
 

Detailed Description

class IKpi

IKpi is responsible for representing one KPI core calculation logic (i.e. calculation of TTC, Max Acceleration etc.) and provide definition of calls to be used inside an evaluator

Member Function Documentation

◆ CalculateKpi()

virtual KpiContent simulation_framework::evaluator::kpi::IKpi::CalculateKpi ( const avx_osi3::GroundTruth &  ground_truth)
pure virtual

Run core logic of KPI calculation. Currently, assume all KPIs needs only subscribe GT for their logic calculation.

Implemented in simulation_framework::evaluator::MinTtcEvaluator.

◆ Init()

virtual void simulation_framework::evaluator::kpi::IKpi::Init ( )
pure virtual

Initialize the logic

Implemented in simulation_framework::evaluator::MinTtcEvaluator.

◆ Reset()

virtual void simulation_framework::evaluator::kpi::IKpi::Reset ( )
pure virtual

Clean up all stored temp data and be ready for next round of new calculation, in case the simulation needs to be restarted

Implemented in simulation_framework::evaluator::MinTtcEvaluator.


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

Connect with Ansys