## On this page

  

 

 # kpi\_definition

 Last update: 16.07.2025 

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

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

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

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

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

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

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

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

<a name="l00012"></a> 12 namespace [simulation\_framework](namespacesimulation__framework.xhtml)

<a name="l00013"></a> 13 {

<a name="l00014"></a> 14 namespace [core](namespacecore.xhtml)

<a name="l00015"></a> 15 {

<a name="l00016"></a> 16 namespace [kpi](namespacekpi.xhtml)

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

<a name="l00018"></a> 18 

<a name="l00019"></a> 19 enum class Type : uint8_t

<a name="l00020"></a> 20 {

<a name="l00022"></a> 22 kScalar = 0, 

<a name="l00023"></a> 23 kTimeSeries, 

<a name="l00024"></a> 24 kLog, 

<a name="l00025"></a> 25 kOther 

<a name="l00026"></a> 26 };

<a name="l00027"></a> 27 

<a name="l00028"></a> 28 class Datatype

<a name="l00029"></a> 29 {

<a name="l00030"></a> 30 public:

<a name="l00031"></a> 31 enum class Value : uint8_t

<a name="l00032"></a> 32 {

<a name="l00034"></a> 34 kDouble = 0,

<a name="l00035"></a> 35 kInteger,

<a name="l00036"></a> 36 kString,

<a name="l00037"></a> 37 kBoolean,

<a name="l00038"></a> 38 kOther

<a name="l00039"></a> 39 };

<a name="l00040"></a> 40 

<a name="l00041"></a> 41 Datatype();

<a name="l00042"></a> 42 Datatype(Value value);

<a name="l00043"></a> 43 Datatype(const std::string&amp; value_string);

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

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

<a name="l00046"></a> 46 

<a name="l00047"></a> 47 operator Value() const;

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

<a name="l00049"></a> 49 std::string ToString() const noexcept;

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

<a name="l00051"></a> 51 

<a name="l00052"></a> 52 bool operator==(Datatype other) const;

<a name="l00053"></a> 53 

<a name="l00054"></a> 54 private:

<a name="l00055"></a> 55 Value value_;

<a name="l00056"></a> 56 };

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

<a name="l00059"></a> 59 

<a name="l00062"></a>[ 62](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml) struct [KpiContent](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml)

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

<a name="l00064"></a> 64 core::time::Timestamp timestamp;

<a name="l00065"></a> 65 std::string name;

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

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

<a name="l00070"></a> 70 std::string unit;

<a name="l00071"></a> 71 Type type;

<a name="l00072"></a> 72 };

<a name="l00073"></a> 73 

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

<a name="l00075"></a> 75 {

<a name="l00076"></a> 76 return (lhs.timestamp == rhs.timestamp) &amp;&amp; (lhs.name == rhs.name) &amp;&amp; (lhs.[data\_type](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml#a4e2c56824798e6d55c9062552059d1bd) == rhs.[data\_type](structsimulation__framework_1_1core_1_1kpi_1_1KpiContent.xhtml#a4e2c56824798e6d55c9062552059d1bd)) &amp;&amp;

<a name="l00077"></a> 77 (lhs.value == rhs.value) &amp;&amp; (lhs.unit == rhs.unit) &amp;&amp; (lhs.type == rhs.type);

<a name="l00078"></a> 78 }

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

<a name="l00085"></a> 85 using KpiMessage = std::vector&lt;KpiContent&gt;;

<a name="l00086"></a> 86 

<a name="l00087"></a> 87 } // namespace kpi

<a name="l00088"></a> 88 } // namespace core

<a name="l00089"></a> 89 } // namespace simulation\_framework