## On this page

  

 

 # kpi\_definition

 Last update: 19.09.2025 

<a id="l00001" name="l00001"></a> 1 

<a id="l00005" name="l00005"></a> 5 

<a id="l00006" name="l00006"></a> 6\#pragma once

<a id="l00007" name="l00007"></a> 7 

<a id="l00008" name="l00008"></a> 8\#include "core/time/i\_clock/i\_clock.h"

<a id="l00009" name="l00009"></a> 9\#include &lt;string&gt;

<a id="l00010" name="l00010"></a> 10\#include &lt;vector&gt;

<a id="l00011" name="l00011"></a> 11 

<a id="l00016" name="l00016"></a> 16namespace [simulation\_framework](namespacesimulation__framework.xhtml)

<a id="l00017" name="l00017"></a> 17{

<a id="l00018" name="l00018"></a> 18namespace [core](namespacecore.xhtml)

<a id="l00019" name="l00019"></a> 19{

<a id="l00020" name="l00020"></a> 20namespace [kpi](namespacekpi.xhtml)

<a id="l00021" name="l00021"></a> 21{

<a id="l00022" name="l00022"></a> 22 

<a id="l00023" name="l00023"></a> 23enum class Type : uint8_t

<a id="l00024" name="l00024"></a> 24{

<a id="l00026" name="l00026"></a> 26 kScalar = 0, 

<a id="l00027" name="l00027"></a> 27 kTimeSeries, 

<a id="l00028" name="l00028"></a> 28 kLog, 

<a id="l00029" name="l00029"></a> 29 kOther 

<a id="l00030" name="l00030"></a> 30};

<a id="l00031" name="l00031"></a> 31 

<a id="l00032" name="l00032"></a> 32class Datatype

<a id="l00033" name="l00033"></a> 33{

<a id="l00034" name="l00034"></a> 34 public:

<a id="l00035" name="l00035"></a> 35 enum class Value : uint8_t

<a id="l00036" name="l00036"></a> 36 {

<a id="l00038" name="l00038"></a> 38 kDouble = 0,

<a id="l00039" name="l00039"></a> 39 kInteger,

<a id="l00040" name="l00040"></a> 40 kString,

<a id="l00041" name="l00041"></a> 41 kBoolean,

<a id="l00042" name="l00042"></a> 42 kOther

<a id="l00043" name="l00043"></a> 43 };

<a id="l00044" name="l00044"></a> 44 

<a id="l00045" name="l00045"></a> 45 Datatype();

<a id="l00046" name="l00046"></a> 46 Datatype(Value value);

<a id="l00047" name="l00047"></a> 47 Datatype(const std::string&amp; value_string);

<a id="l00048" name="l00048"></a> 48 

<a id="l00049" name="l00049"></a> 49 ~Datatype() = default;

<a id="l00050" name="l00050"></a> 50 

<a id="l00051" name="l00051"></a> 51 operator Value() const;

<a id="l00052" name="l00052"></a> 52 

<a id="l00053" name="l00053"></a> 53 std::string ToString() const noexcept;

<a id="l00054" name="l00054"></a> 54 void FromString(const std::string&amp; value_string) noexcept;

<a id="l00055" name="l00055"></a> 55 

<a id="l00056" name="l00056"></a> 56 bool operator==(Datatype other) const;

<a id="l00057" name="l00057"></a> 57 

<a id="l00058" name="l00058"></a> 58 private:

<a id="l00059" name="l00059"></a> 59 Value value_;

<a id="l00060" name="l00060"></a> 60};

<a id="l00061" name="l00061"></a> 61 

<a id="l00063" name="l00063"></a> 63 

<a id="l00066" name="l00066"></a>[ 66](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml)[struct](classsimulation__framework_1_1core_1_1Topic.xhtml) [KpiContent](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml)

<a id="l00067" name="l00067"></a> 67{

<a id="l00068" name="l00068"></a> 68 core::time::Timestamp timestamp;

<a id="l00069" name="l00069"></a> 69 std::string name;

<a id="l00072" name="l00072"></a>[ 72](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml#a4e2c56824798e6d55c9062552059d1bd) Datatype [data\_type](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml#a4e2c56824798e6d55c9062552059d1bd);

<a id="l00073" name="l00073"></a> 73 std::string value;

<a id="l00074" name="l00074"></a> 74 std::string unit;

<a id="l00075" name="l00075"></a> 75 Type type;

<a id="l00076" name="l00076"></a> 76};



<a id="l00077" name="l00077"></a> 77 

<a id="l00078" name="l00078"></a> 78inline bool operator==(const [core::kpi::KpiContent](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml)&amp; [lhs](classsimulation__framework_1_1core_1_1Topic.xhtml), const [core::kpi::KpiContent](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml)&amp; [rhs](classsimulation__framework_1_1core_1_1Topic.xhtml))

<a id="l00079" name="l00079"></a> 79{

<a id="l00080" name="l00080"></a> 80 return ([lhs](classsimulation__framework_1_1core_1_1Topic.xhtml).timestamp == [rhs](classsimulation__framework_1_1core_1_1Topic.xhtml).timestamp) &amp;&amp; ([lhs](classsimulation__framework_1_1core_1_1Topic.xhtml).name == [rhs](classsimulation__framework_1_1core_1_1Topic.xhtml).name) &amp;&amp; ([lhs](classsimulation__framework_1_1core_1_1Topic.xhtml).data_type == [rhs](classsimulation__framework_1_1core_1_1Topic.xhtml).data_type) &amp;&amp;

<a id="l00081" name="l00081"></a> 81 ([lhs](classsimulation__framework_1_1core_1_1Topic.xhtml).value == [rhs](classsimulation__framework_1_1core_1_1Topic.xhtml).value) &amp;&amp; ([lhs](classsimulation__framework_1_1core_1_1Topic.xhtml).unit == [rhs](classsimulation__framework_1_1core_1_1Topic.xhtml).unit) &amp;&amp; ([lhs](classsimulation__framework_1_1core_1_1Topic.xhtml).type == [rhs](classsimulation__framework_1_1core_1_1Topic.xhtml).type);

<a id="l00082" name="l00082"></a> 82}

<a id="l00083" name="l00083"></a> 83 

<a id="l00089" name="l00089"></a> 89using KpiMessage = std::vector&lt;KpiContent&gt;;

<a id="l00090" name="l00090"></a> 90 

<a id="l00091" name="l00091"></a> 91} // namespace kpi

<a id="l00092" name="l00092"></a> 92} // namespace core

<a id="l00093" name="l00093"></a> 93} // namespace simulation\_framework

[simulation\_framework::core::Topic](classsimulation__framework_1_1core_1_1Topic.xhtml)

This is the concrete Topic class that can be used for creation of a communication channel with given ...

**Definition** [topic.h:38](topic_8h_source.xhtml#l00037)



[core](namespacecore.xhtml)

The namespace for all core functionalities under namespace simulation_framework.



[kpi](namespacekpi.xhtml)

The namespace for kpi definition and corresponding APIs under namespace simulation_framework::evaluat...



[simulation\_framework](namespacesimulation__framework.xhtml)

The top namespace for simulation framework.



[simulation\_framework::core::kpi::KpiContent](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml)

struct KpiContent

**Definition** [kpi\_definition.h:67](kpi__definition_8h_source.xhtml#l00066)



[simulation\_framework::core::kpi::KpiContent::data\_type](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml#a4e2c56824798e6d55c9062552059d1bd)

Datatype data_type

**Definition** [kpi\_definition.h:72](kpi__definition_8h_source.xhtml#l00072)