Fix logging (#70)

* Fix private logging

Signed-off-by: ClemensLinnhoff <[email protected]>

* Add OSMPVersion and MODELVERSION for modelDescription.xml

Signed-off-by: ClemensLinnhoff <[email protected]>

* Fix public logging
Signed-off-by: Marcel Kettelgerdes <[email protected]>

---------

Signed-off-by: ClemensLinnhoff <[email protected]>
Signed-off-by: Marcel Kettelgerdes <[email protected]>
Co-authored-by: Marcel Kettelgerdes <[email protected]>

Author: ClemensLinnhoff

.clang-tidy

@@ -6,21 +6,21 @@ CheckOptions:
   - key:             readability-identifier-naming.AbstractClassCases
     value:           CamelCase
   - key:             readability-identifier-naming.AbstractClassPrefix
-    value:           I
+    value:           ''
   - key:             readability-identifier-naming.AbstractClassSuffix
     value:           ''
   - key:             readability-identifier-naming.ClassCase
     value:           CamelCase
   - key:             readability-identifier-naming.ClassConstantCase
     value:           CamelCase
   - key:             readability-identifier-naming.ClassConstantPrefix
-    value:           k
+    value:           ''
   - key:             readability-identifier-naming.ClassConstantSuffix
     value:           ''
   - key:             readability-identifier-naming.ClassMemberCase
     value:           lower_case
   - key:             readability-identifier-naming.ClassMemberPrefix
-    value:           g_
+    value:           ''
   - key:             readability-identifier-naming.ClassMemberSuffix
     value:           ''
   - key:             readability-identifier-naming.ClassMethodCase
@@ -74,7 +74,7 @@ CheckOptions:
   - key:             readability-identifier-naming.EnumConstantCase
     value:           aNy_CasE
   - key:             readability-identifier-naming.EnumConstantPrefix
-    value:           k
+    value:           ''
   - key:             readability-identifier-naming.EnumConstantSuffix
     value:           ''
   - key:             readability-identifier-naming.EnumPrefix
@@ -90,7 +90,7 @@ CheckOptions:
   - key:             readability-identifier-naming.GlobalConstantCase
     value:           CamelCase
   - key:             readability-identifier-naming.GlobalConstantPrefix
-    value:           k
+    value:           ''
   - key:             readability-identifier-naming.GlobalConstantSuffix
     value:           ''
   - key:             readability-identifier-naming.GlobalFunctionCase
@@ -102,11 +102,11 @@ CheckOptions:
   - key:             readability-identifier-naming.GlobalVariableCase
     value:           lower_case
   - key:             readability-identifier-naming.GlobalVariablePrefix
-    value:           g_
+    value:           ''
   - key:             readability-identifier-naming.GlobalVariableSuffix
     value:           ''
   - key:             readability-identifier-naming.IgnoreFailedSplit
-    value:           '0'
+    value:           ''
   - key:             readability-identifier-naming.InlineNamespaceCase
     value:           lower_case
   - key:             readability-identifier-naming.InlineNamespacePrefix

CMakeLists.txt

@@ -8,6 +8,8 @@ get_directory_property(OSI_VERSION_MAJOR DIRECTORY lib/open-simulation-interface
 get_directory_property(OSI_VERSION_MINOR DIRECTORY lib/open-simulation-interface DEFINITION VERSION_MINOR)
 get_directory_property(OSI_VERSION_PATCH DIRECTORY lib/open-simulation-interface DEFINITION VERSION_PATCH)
 set(OSIVERSION "${OSI_VERSION_MAJOR}.${OSI_VERSION_MINOR}.${OSI_VERSION_PATCH}")
+set(OSMPVERSION "1.4.0" CACHE STRING "OSMP Version String")
+set(MODELVERSION "0.5.0" CACHE STRING "Model Version String")
 
 include_directories(lib/fmi2/headers)
 

src/CMakeLists.txt

@@ -1,12 +1,23 @@
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(LINK_WITH_SHARED_OSI OFF CACHE BOOL "Link FMU with shared OSI library instead of statically linking")
-set(PUBLIC_LOGGING OFF CACHE BOOL "Enable logging via FMI logger")
-set(PRIVATE_LOGGING OFF CACHE BOOL "Enable private logging to file")
+set(PUBLIC_LOGGING ON CACHE BOOL "Enable logging via FMI logger")
+set(PRIVATE_LOGGING ON CACHE BOOL "Enable private logging to file")
+if(WIN32)
+	set(PRIVATE_LOG_PATH "C:/TEMP/sl-1-0-sensor-model-repository-template.log" CACHE FILEPATH "Path to write private log file to")
+else()
+	set(PRIVATE_LOG_PATH "/tmp/sl-1-0-sensor-model-repository-template.log" CACHE FILEPATH "Path to write private log file to")
+endif()
+if(PRIVATE_LOGGING)
+	file(TO_NATIVE_PATH ${PRIVATE_LOG_PATH} PRIVATE_LOG_PATH_NATIVE)
+	string(REPLACE "\\" "\\\\" PRIVATE_LOG_PATH ${PRIVATE_LOG_PATH_NATIVE})
+endif()
+set(VERBOSE_FMI_LOGGING OFF CACHE BOOL "Enable detailed FMI function logging")
 
 string(TIMESTAMP FMUTIMESTAMP UTC)
 string(MD5 FMUGUID modelDescription.in.xml)
 configure_file(modelDescription.in.xml modelDescription.xml @ONLY)
+configure_file(OSMPConfig.in.h OSMPConfig.h)
 
 find_package(Protobuf 2.6.1 REQUIRED)
 add_library(sl-1-0-sensor-model-repository-template SHARED
@@ -22,6 +33,8 @@ else()
 	target_link_libraries(sl-1-0-sensor-model-repository-template open_simulation_interface_pic)
 endif()
 
+include_directories(${CMAKE_CURRENT_BINARY_DIR})
+
 if(WIN32)
 	if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 		set(FMI_BINARIES_PLATFORM "win64")
@@ -51,6 +64,7 @@ add_custom_command(TARGET sl-1-0-sensor-model-repository-template
 		COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_BINARY_DIR}/modelDescription.xml" "${CMAKE_CURRENT_BINARY_DIR}/buildfmu"
 		COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/OSMP.cpp" "${CMAKE_CURRENT_BINARY_DIR}/buildfmu/sources/"
 		COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/OSMP.h" "${CMAKE_CURRENT_BINARY_DIR}/buildfmu/sources/"
+		COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_BINARY_DIR}/OSMPConfig.h" "${CMAKE_CURRENT_BINARY_DIR}/buildfmu/sources/"
 		COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/MySensorModel.cpp" "${CMAKE_CURRENT_BINARY_DIR}/buildfmu/sources/"
 		COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/MySensorModel.h" "${CMAKE_CURRENT_BINARY_DIR}/buildfmu/sources/"
 		COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/../sl-1-0-sensor-model-repository-template.srmd" "${CMAKE_CURRENT_BINARY_DIR}/buildfmu/extra/net.pmsf.ssp.srmd/resourceMetaData.srmd"

src/MySensorModel.cpp

@@ -13,8 +13,20 @@
 #include "osi_sensordata.pb.h"
 #include "osi_sensorview.pb.h"
 
-void MySensorModel::Init(double nominal_range_in)
+#ifdef PRIVATE_LOG_PATH
+ofstream MySensorModel::private_log_file;
+#endif
+
+void MySensorModel::Init(double nominal_range_in, string theinstance_name, fmi2CallbackFunctions thefunctions, bool thelogging_on)
 {
+    logging_categories_.clear();
+    logging_categories_.insert("FMI");
+    logging_categories_.insert("OSMP");
+    logging_categories_.insert("OSI");
+    instance_name_ = theinstance_name;
+    functions_ = thefunctions;
+    logging_on_ = thelogging_on;
+
     nominal_range_ = nominal_range_in;
 }
 

src/MySensorModel.h

@@ -6,13 +6,23 @@
 //
 
 #pragma once
+#include <cstdarg>
+#include <fstream>
+#include <iostream>
+#include <set>
+#include <string>
 
+#include "OSMPConfig.h"
+#include "fmi2Functions.h"
 #include "osi_sensordata.pb.h"
 
+using namespace std;
+
 class MySensorModel
 {
   public:
-    void Init(double nominal_range_in);
+    void Init(double nominal_range_in, string theinstance_name, fmi2CallbackFunctions thefunctions, bool thelogging_on);
+
     osi3::SensorData Step(osi3::SensorView current_in, double time);
 
     static void RotatePointXYZ(double x, double y, double z, double yaw, double pitch, double roll, double& rx, double& ry, double& rz);
@@ -40,6 +50,11 @@ class MySensorModel
                                                    double mounting_position_roll);
 
   private:
+    string instance_name_;
+    bool logging_on_;
+    set<string> logging_categories_;
+    fmi2CallbackFunctions functions_;
+
     double nominal_range_;
 
     /* Private File-based Logging just for Debugging */
@@ -55,7 +70,9 @@ class MySensorModel
         va_start(ap, format);
         char buffer[1024];
         if (!private_log_file.is_open())
+        {
             private_log_file.open(PRIVATE_LOG_PATH, ios::out | ios::app);
+        }
         if (private_log_file.is_open())
         {
 #ifdef _WIN32
@@ -82,17 +99,23 @@ class MySensorModel
 #endif
 #ifdef PRIVATE_LOG_PATH
         if (!private_log_file.is_open())
+        {
             private_log_file.open(PRIVATE_LOG_PATH, ios::out | ios::app);
+        }
         if (private_log_file.is_open())
         {
-            private_log_file << "OSMPDummySensor"
-                             << "::" << instanceName << "<" << ((void*)this) << ">:" << category << ": " << buffer << endl;
+            private_log_file << "MySensorModel"
+                             << "::"
+                             << "template"
+                             << "<" << ((void*)this) << ">:" << category << ": " << buffer << endl;
             private_log_file.flush();
         }
 #endif
 #ifdef PUBLIC_LOGGING
-        if (loggingOn && loggingCategories.count(category))
-            functions.logger(functions.componentEnvironment, instanceName.c_str(), fmi2OK, category, buffer);
+        if (logging_on_ && (logging_categories_.count(category) != 0U))
+        {
+            functions_.logger(functions_.componentEnvironment, instance_name_.c_str(), fmi2OK, category, buffer);
+        }
 #endif
 #endif
     }
@@ -113,7 +136,7 @@ class MySensorModel
 #if defined(PRIVATE_LOG_PATH) || defined(PUBLIC_LOGGING)
         va_list ap;
         va_start(ap, format);
-        internal_log(category, format, ap);
+        InternalLog(category, format, ap);
         va_end(ap);
 #endif
     }

src/OSMP.cpp

@@ -47,7 +47,7 @@
 using namespace std;
 
 #ifdef PRIVATE_LOG_PATH
-ofstream COSMPDummySensor::private_log_file;
+ofstream OSMP::private_log_file;
 #endif
 
 /*
@@ -262,7 +262,7 @@ fmi2Status OSMP::DoExitInitializationMode()
     }
 
     // initialize sensor model
-    my_sensor_model_.Init(FmiNominalRange());
+    my_sensor_model_.Init(FmiNominalRange(), instance_name_, functions_, logging_on_);
 
     return fmi2OK;
 }

src/OSMP.h

@@ -9,6 +9,7 @@
 #ifndef FMU_SHARED_OBJECT
 #define FMI2_FUNCTION_PREFIX OSMPDummySensor_
 #endif
+#include "OSMPConfig.h"
 #include "fmi2Functions.h"
 
 /*
@@ -168,17 +169,23 @@ class OSMP
 #endif
 #ifdef PRIVATE_LOG_PATH
         if (!private_log_file.is_open())
+        {
             private_log_file.open(PRIVATE_LOG_PATH, ios::out | ios::app);
+        }
         if (private_log_file.is_open())
         {
-            private_log_file << "OSMPDummySensor"
-                             << "::" << instanceName << "<" << ((void*)this) << ">:" << category << ": " << buffer << endl;
+            private_log_file << "OSMP"
+                             << "::"
+                             << "model"
+                             << "<" << ((void*)this) << ">:" << category << ": " << buffer << endl;
             private_log_file.flush();
         }
 #endif
 #ifdef PUBLIC_LOGGING
-        if (loggingOn && loggingCategories.count(category))
-            functions.logger(functions.componentEnvironment, instanceName.c_str(), fmi2OK, category, buffer);
+        if (logging_on_ && (logging_categories_.count(category) != 0U))
+        {
+            functions_.logger(functions_.componentEnvironment, instance_name_.c_str(), fmi2OK, category, buffer);
+        }
 #endif
 #endif
     }
@@ -199,7 +206,7 @@ class OSMP
 #if defined(PRIVATE_LOG_PATH) || defined(PUBLIC_LOGGING)
         va_list ap;
         va_start(ap, format);
-        internal_log(category, format, ap);
+        InternalLog(category, format, ap);
         va_end(ap);
 #endif
     }

src/OSMPConfig.in.h

@@ -0,0 +1,11 @@
+//
+// Copyright 2016 -- 2018 PMSF IT Consulting Pierre R. Mai
+// Copyright 2023 BMW AG
+// SPDX-License-Identifier: MPL-2.0
+//
+
+#cmakedefine PUBLIC_LOGGING
+#cmakedefine PRIVATE_LOG_PATH "@PRIVATE_LOG_PATH@"
+#cmakedefine VERBOSE_FMI_LOGGING
+#cmakedefine DEBUG_BREAKS
+#define FMU_GUID "@FMUGUID@"

src/modelDescription.in.xml

@@ -5,7 +5,7 @@
   guid="@FMUGUID@"
   description="Demonstration C++ Sensor FMU for OSI Sensor Model Packaging within OpenMSL"
   author="Persival GmbH"
-  version="@OSMPVERSION@"
+  version="@MODELVERSION@"
   generationTool="Based on OSMPDummySensor"
   generationDateAndTime="@FMUTIMESTAMP@"
   variableNamingConvention="structured">

test/unit/CMakeLists.txt

@@ -3,6 +3,7 @@ project(UnitTests)
 # 'lib' is the folder with Google Test sources
 add_subdirectory(lib)
 include_directories(${gtest_SOURCE_DIR}/include ${gtest_SOURCE_DIR})
+include_directories(${CMAKE_CURRENT_BINARY_DIR}/../../src)
 
 # 'Google_Tests_run' is the target name
 # 'test1.cpp tests2.cpp' are source files with tests