Namespace simulation_framework::core::kpi

Definition: core/kpi/kpi_message_converter/kpi_message_converter.h (line 18)

Classes

• simulation_framework::core::kpi::Datatype
• simulation_framework::core::kpi::IKpi
• simulation_framework::core::kpi::IKpiMessageConverter
• simulation_framework::core::kpi::KpiContent
• simulation_framework::core::kpi::KpiMessageConverter

Enumeration types

Enumeration type Type

Definition: core/kpi/definition/kpi_definition.h (line 23)

enum Type {
  kScalar = 0,
  kTimeSeries,
  kLog,
  kOther
}

Enumerator kScalar

Type of this KPI, this affects how the KPI should be logged.

kScalar: The KPI is scalar value with unit

Enumerator kTimeSeries

kTimeSeries: The KPI is a time serie

Enumerator kLog

kLog: The KPI is a continuous log

Enumerator kOther

kOther: Other type of KPI

Typedefs

Typedef KpiMessage

Definition: core/kpi/definition/kpi_definition.h (line 90)

using simulation_framework::core::kpi::KpiMessage = typedef std::vector<kpicontent>

C++ type definition: KpiMessage is a vector of KpiContent. This is native C++ type and it can be converted into DDS message type rtidds::KpiMessage using converter evaluator/kpi/kpi_message_converter/kpi_message_converter.h. Message published into KpiLoggerTopic will be captured by default KpiLoggerActivity and each extra KPI content will be logged into the output json as additional value of complete KPI results.

Return type: std::vector KpiContent >

Functions

Function operator==

bool simulation_framework::core::kpi::operator==(const core::kpi::KpiContent &lhs, const core::kpi::KpiContent &rhs)

Parameters:

• const core::kpi::KpiContent & lhs
• const core::kpi::KpiContent & rhs

Return type: bool

[static]: https://img.shields.io/badge/-static-lightgrey (static)