Class simulation_framework::core::kpi::IKpi
Last update: 22.04.2026
Definition: core/kpi/i_kpi/i_kpi.h (line 39)
Represents core KPI calculation logic.
The IKpi template class defines the interface for calculating a Key Performance Indicator (KPI) based on a specific input type. It includes initialization, reset, and calculation methods for KPI evaluators. Example KPIs include Time to Collision (TTC) or Maximum Acceleration.
parameterlist {"type":"element","name":"parameterlist","attributes":{"kind":"templateparam"},"children":[{"type":"element","name":"parameteritem","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"parameternamelist","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"parametername","attributes":{},"children":[{"type":"text","text":"T"}]},{"type":"text","text":"\n"}]},{"type":"text","text":"\n"},{"type":"element","name":"parameterdescription","attributes":{},"children":[{"type":"text","text":"\n"},{"type":"element","name":"para","attributes":{},"children":[{"type":"text","text":"The type of input data used for KPI calculations. "}]},{"type":"text","text":"\n"}]},{"type":"text","text":"\n"}]},{"type":"text","text":"\n"}]}
See also: KpiContent, kpi::Type
Template parameters:
Members
Public functions
Function ~IKpi
virtual simulation_framework::core::kpi::IKpi< T >::~IKpi()=default
Virtual destructor for proper cleanup of derived classes.
Return type:
Function Init
virtual void simulation_framework::core::kpi::IKpi< T >::Init()=0
Initializes the KPI logic.
Sets up any necessary state or resources required for KPI calculation.
Return type: void
Reimplemented by:
Function Reset
virtual void simulation_framework::core::kpi::IKpi< T >::Reset()=0
Resets the KPI logic.
Clears temporary data and prepares the KPI logic for a new calculation, especially if the simulation needs to be restarted.
Return type: void
Reimplemented by:
Function CalculateKpi
virtual KpiContent simulation_framework::core::kpi::IKpi< T >::CalculateKpi(const T &input)=0
Executes the core KPI calculation logic.
Parameters:
- input: The input data required for KPI calculation.
Returns:
The calculated KPI content as a KpiContent object.
Parameters:
Return type: KpiContent
Reimplemented by:
Function GetKpiType
virtual kpi::Type simulation_framework::core::kpi::IKpi< T >::GetKpiType() const =0
Retrieves the KPI type.
Indicates the type of KPI, which can be one of the following:
-
kpi::Type::kScalar: A scalar value with a unit. -
kpi::Type::kTimeSeries: A time series representation. -
kpi::Type::kLog: A continuous log.
Returns:
The type of the KPI as a kpi::Type enum value.
Return type: kpi::Type
Reimplemented by:
