## On this page

  

 

 # logging

 Last update: 16.07.2025 

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

<a id="l00003" name="l00003"></a> 3 

<a id="l00004" name="l00004"></a> 4\#pragma once

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

<a id="l00006" name="l00006"></a> 6\#include "core/logging/console\_logger.h"

<a id="l00007" name="l00007"></a> 7\#include "core/logging/i\_logger.h"

<a id="l00008" name="l00008"></a> 8\#include &lt;memory&gt;

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

<a id="l00010" name="l00010"></a> 10 

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

<a id="l00016" name="l00016"></a> 16{

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

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

<a id="l00019" name="l00019"></a> 19namespace logging

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

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

<a id="l00027" name="l00027"></a>[ 27](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)class [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)

<a id="l00028" name="l00028"></a> 28{

<a id="l00029" name="l00029"></a> 29 public:

<a id="l00030" name="l00030"></a> 30 using ILoggerContainer = std::vector&lt;std::unique_ptr&lt;ILogger&gt;&gt;;

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

<a id="l00032" name="l00032"></a> 32 virtual [~LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)() = default;

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

<a id="l00034" name="l00034"></a> 34 [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)(const [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)&amp;) = delete;

<a id="l00035" name="l00035"></a> 35 [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)&amp; operator=(const [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)&amp;) = delete;

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

<a id="l00038" name="l00038"></a>[ 38](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747) static [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)&amp; [GetInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747)()

<a id="l00039" name="l00039"></a> 39 {

<a id="l00040" name="l00040"></a> 40 static [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml) [log\_instance](classsimulation__framework_1_1core_1_1Topic.xhtml) = [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)();

<a id="l00041" name="l00041"></a> 41 return [log\_instance](classsimulation__framework_1_1core_1_1Topic.xhtml);

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



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

<a id="l00046" name="l00046"></a>[ 46](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#ac2a261893f38c22e6a86d333e7a93644) void [RegisterLogger](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#ac2a261893f38c22e6a86d333e7a93644)(std::unique_ptr&lt;ILogger&gt; [logger](classsimulation__framework_1_1core_1_1Topic.xhtml)) { loggers_.push_back(std::move([logger](classsimulation__framework_1_1core_1_1Topic.xhtml))); }

<a id="l00047" name="l00047"></a> 47 

<a id="l00049" name="l00049"></a>[ 49](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a8d0242626303b56597a921397ccf0313) void [ClearLoggers](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a8d0242626303b56597a921397ccf0313)() { loggers_.clear(); }

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

<a id="l00052" name="l00052"></a>[ 52](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a2eb401fe3115b87936427b9ca29cd05a) const ILoggerContainer&amp; [GetLoggers](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a2eb401fe3115b87936427b9ca29cd05a)() const { return loggers_; }

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

<a id="l00057" name="l00057"></a>[ 57](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a2536343b1dc6df11fa67321a4e41e525) void [Log](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a2536343b1dc6df11fa67321a4e41e525)(LogLevel [level](classsimulation__framework_1_1core_1_1Topic.xhtml), std::string_view [message](classsimulation__framework_1_1core_1_1Topic.xhtml))

<a id="l00058" name="l00058"></a> 58 {

<a id="l00059" name="l00059"></a> 59 for (const auto&amp; [logger](classsimulation__framework_1_1core_1_1Topic.xhtml) : loggers_)

<a id="l00060" name="l00060"></a> 60 {

<a id="l00061" name="l00061"></a> 61 if ([logger](classsimulation__framework_1_1core_1_1Topic.xhtml))

<a id="l00062" name="l00062"></a> 62 {

<a id="l00063" name="l00063"></a> 63 [logger](classsimulation__framework_1_1core_1_1Topic.xhtml)-&gt;Log([level](classsimulation__framework_1_1core_1_1Topic.xhtml), [message](classsimulation__framework_1_1core_1_1Topic.xhtml));

<a id="l00064" name="l00064"></a> 64 }

<a id="l00065" name="l00065"></a> 65 }

<a id="l00066" name="l00066"></a> 66 }



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

<a id="l00070" name="l00070"></a>[ 70](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a3062c31daef0227b191825fc9ce19d1a) void [SetLogLevel](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a3062c31daef0227b191825fc9ce19d1a)(LogLevel log_level)

<a id="l00071" name="l00071"></a> 71 {

<a id="l00072" name="l00072"></a> 72 for (const auto&amp; [logger](classsimulation__framework_1_1core_1_1Topic.xhtml) : loggers_)

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

<a id="l00074" name="l00074"></a> 74 if ([logger](classsimulation__framework_1_1core_1_1Topic.xhtml))

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

<a id="l00076" name="l00076"></a> 76 [logger](classsimulation__framework_1_1core_1_1Topic.xhtml)-&gt;SetCurrentLogLevel(log_level);

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

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

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



<a id="l00080" name="l00080"></a> 80 

<a id="l00081" name="l00081"></a> 81 private:

<a id="l00082" name="l00082"></a> 82 [LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)() { [RegisterLogger](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#ac2a261893f38c22e6a86d333e7a93644)(std::make_unique&lt;simulation_framework::core::logging::ConsoleLogger&gt;()); };

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

<a id="l00084" name="l00084"></a> 84 ILoggerContainer loggers_;

<a id="l00085" name="l00085"></a> 85};



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

<a id="l00089" name="l00089"></a> 89static inline void SetLogLevel(LogLevel log_level) noexcept

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

<a id="l00091" name="l00091"></a> 91 [LoggingInstance::GetInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747)().SetLogLevel(log_level);

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

<a id="l00093" name="l00093"></a> 93 

<a id="l00097" name="l00097"></a> 97static inline void Debug(std::string_view message) noexcept

<a id="l00098" name="l00098"></a> 98{

<a id="l00099" name="l00099"></a> 99 [LoggingInstance::GetInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747)().Log(LogLevel::kDebug, message);

<a id="l00100" name="l00100"></a> 100}

<a id="l00101" name="l00101"></a> 101 

<a id="l00105" name="l00105"></a> 105static inline void Info(std::string_view message) noexcept

<a id="l00106" name="l00106"></a> 106{

<a id="l00107" name="l00107"></a> 107 [LoggingInstance::GetInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747)().Log(LogLevel::kInfo, message);

<a id="l00108" name="l00108"></a> 108}

<a id="l00109" name="l00109"></a> 109 

<a id="l00113" name="l00113"></a> 113static inline void Warning(std::string_view message) noexcept

<a id="l00114" name="l00114"></a> 114{

<a id="l00115" name="l00115"></a> 115 [LoggingInstance::GetInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747)().Log(LogLevel::kWarning, message);

<a id="l00116" name="l00116"></a> 116}

<a id="l00117" name="l00117"></a> 117 

<a id="l00121" name="l00121"></a> 121static inline void Error(std::string_view message) noexcept

<a id="l00122" name="l00122"></a> 122{

<a id="l00123" name="l00123"></a> 123 [LoggingInstance::GetInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747)().Log(LogLevel::kError, message);

<a id="l00124" name="l00124"></a> 124}

<a id="l00125" name="l00125"></a> 125 

<a id="l00126" name="l00126"></a> 126} // namespace logging

<a id="l00127" name="l00127"></a> 127} // namespace core

<a id="l00128" name="l00128"></a> 128} // 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)



[simulation\_framework::core::logging::LoggingInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml)

A singleton class to be used for all logging purposes. It can be used to register additional loggers ...

**Definition** [logging.h:28](logging_8h_source.xhtml#l00027)



[simulation\_framework::core::logging::LoggingInstance::Log](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a2536343b1dc6df11fa67321a4e41e525)

void Log(LogLevel level, std::string_view message)

Log a message on the logging interface.

**Definition** [logging.h:57](logging_8h_source.xhtml#l00057)



[simulation\_framework::core::logging::LoggingInstance::GetLoggers](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a2eb401fe3115b87936427b9ca29cd05a)

const ILoggerContainer &amp; GetLoggers() const

Return a const reference to the container of registered loggers.

**Definition** [logging.h:52](logging_8h_source.xhtml#l00052)



[simulation\_framework::core::logging::LoggingInstance::SetLogLevel](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a3062c31daef0227b191825fc9ce19d1a)

void SetLogLevel(LogLevel log_level)

Set Log level of all registered loggers.

**Definition** [logging.h:70](logging_8h_source.xhtml#l00070)



[simulation\_framework::core::logging::LoggingInstance::GetInstance](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a452a2f89b01be3de22e5c93b9e515747)

static LoggingInstance &amp; GetInstance()

Returns a reference to global singleton logging instance.

**Definition** [logging.h:38](logging_8h_source.xhtml#l00038)



[simulation\_framework::core::logging::LoggingInstance::ClearLoggers](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#a8d0242626303b56597a921397ccf0313)

void ClearLoggers()

Remove all currently registered loggers.

**Definition** [logging.h:49](logging_8h_source.xhtml#l00049)



[simulation\_framework::core::logging::LoggingInstance::RegisterLogger](classsimulation__framework_1_1core_1_1logging_1_1LoggingInstance.xhtml#ac2a261893f38c22e6a86d333e7a93644)

void RegisterLogger(std::unique_ptr&lt; ILogger &gt; logger)

Register a new logger.

**Definition** [logging.h:46](logging_8h_source.xhtml#l00046)



[core](namespacecore.xhtml)

The namespace for all core functionalities under namespace simulation_framework.



[simulation\_framework](namespacesimulation__framework.xhtml)

The top namespace for simulation framework.