Class simulation_framework::evaluator::DistanceDrivenEvaluator

Definition: autonomy/evaluator/distance_driven_evaluator/distance_driven_evaluator.h (line 29)

class DistanceDrivenEvaluator

Definition of DistanceDrivenEvaluator class to To fulfill this we want to implement a KPI evaluator that aggregates the distance driven by the ego vehicle over the course of the simulation.

Inherits from:

• simulation_framework::core::kpi::IKpi\ osi3::GroundTruth >

Members

• CalculateKpi
• DistanceDrivenEvaluator
• GetKpiType
• Init
• Reset
• ~DistanceDrivenEvaluator
• ~IKpi

Public functions

Function DistanceDrivenEvaluator

simulation_framework::evaluator::DistanceDrivenEvaluator::DistanceDrivenEvaluator(const std::string &kpi_name="driven_dist")

Parameters:

• const std::string & kpi_name = "driven_dist"

Return type:

Function ~DistanceDrivenEvaluator

simulation_framework::evaluator::DistanceDrivenEvaluator::~DistanceDrivenEvaluator()=default

Return type:

Function Init

void simulation_framework::evaluator::DistanceDrivenEvaluator::Init() override

Initializes the KPI logic.

Sets up any necessary state or resources required for KPI calculation.

Return type: void

Reimplements: Init

Function Reset

void simulation_framework::evaluator::DistanceDrivenEvaluator::Reset() override

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

Reimplements: Reset

Function CalculateKpi

core::kpi::KpiContent simulation_framework::evaluator::DistanceDrivenEvaluator::CalculateKpi(const osi3::GroundTruth &ground_truth) override

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:

• const osi3::GroundTruth & input

Return type: core::kpi::KpiContent

Reimplements: CalculateKpi

Function GetKpiType

core::kpi::Type simulation_framework::evaluator::DistanceDrivenEvaluator::GetKpiType() const override

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: core::kpi::Type

Reimplements: GetKpiType