Add trace_name as an additional FMI parameter

[ClemensLinnhoff]

Reference to a related issue in the repository
#5

Add a description
Add trace name as additional parameter

Take this checklist as orientation for yourself, if this PR is ready for Maintainer Review

• My suggestion follows the governance rules.
• All commits of this PR are signed.
• My changes generate no errors when passing CI tests.
• I updated all documentation (readmes incl. figures) according to my changes.
• I have successfully implemented and tested my fix/feature locally.
• Appropriate reviewer(s) are assigned.

[github-actions]

Cpp-Linter Report ⚠️

Some files did not pass the configured checks!

clang-format reports: 1 file(s) not formatted

• src/OSMPTraceFilePlayer.h

clang-tidy reports: 36 concern(s)

• src/OSMPTraceFilePlayer.cpp:62:22: warning: [cppcoreguidelines-no-malloc]

  do not manage memory manually; consider std::vector or std::string

      new_ptr = (char*)realloc(new_ptr, new_size);
                       ^~~~~~~~~~~~~~~~~~~~~~~~~~

• src/OSMPTraceFilePlayer.cpp:74:5: warning: [cppcoreguidelines-pro-type-member-init]

  uninitialized record type: 'myaddr'

      union addrconv
      ^

• src/OSMPTraceFilePlayer.cpp:74:11: warning: [readability-identifier-naming]

  invalid case style for union 'addrconv'

      union addrconv
            ^~~~~~~~
            Addrconv

• src/OSMPTraceFilePlayer.cpp:83:12: warning: [cppcoreguidelines-pro-type-union-access]

  do not access members of unions; use (boost::)variant instead

      myaddr.base.lo = lo;
             ^

• src/OSMPTraceFilePlayer.cpp:84:12: warning: [cppcoreguidelines-pro-type-union-access]

  do not access members of unions; use (boost::)variant instead

      myaddr.base.hi = hi;
             ^

• src/OSMPTraceFilePlayer.cpp:85:12: warning: [cppcoreguidelines-pro-type-reinterpret-cast]

  do not use reinterpret_cast

      return reinterpret_cast<void*>(myaddr.address);
             ^

• src/OSMPTraceFilePlayer.cpp:85:43: warning: [cppcoreguidelines-pro-type-union-access]

  do not access members of unions; use (boost::)variant instead

      return reinterpret_cast<void*>(myaddr.address);
                                            ^

• src/OSMPTraceFilePlayer.cpp:96:5: warning: [cppcoreguidelines-pro-type-member-init]

  uninitialized record type: 'myaddr'

      union addrconv
      ^

• src/OSMPTraceFilePlayer.cpp:96:11: warning: [readability-identifier-naming]

  invalid case style for union 'addrconv'

      union addrconv
            ^~~~~~~~
            Addrconv

• src/OSMPTraceFilePlayer.cpp:105:12: warning: [cppcoreguidelines-pro-type-union-access]

  do not access members of unions; use (boost::)variant instead

      myaddr.address = reinterpret_cast<unsigned long long>(ptr);
             ^

• src/OSMPTraceFilePlayer.cpp:105:22: warning: [cppcoreguidelines-pro-type-reinterpret-cast]

  do not use reinterpret_cast

      myaddr.address = reinterpret_cast<unsigned long long>(ptr);
                       ^

• src/OSMPTraceFilePlayer.cpp:106:17: warning: [cppcoreguidelines-pro-type-union-access]

  do not access members of unions; use (boost::)variant instead

      hi = myaddr.base.hi;
                  ^

• src/OSMPTraceFilePlayer.cpp:107:17: warning: [cppcoreguidelines-pro-type-union-access]

  do not access members of unions; use (boost::)variant instead

      lo = myaddr.base.lo;
                  ^

• src/OSMPTraceFilePlayer.cpp:167:9: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

          boolean_vars_[i] = fmi2False;
          ^

• src/OSMPTraceFilePlayer.cpp:173:9: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

          integer_vars_[i] = 0;
          ^

• src/OSMPTraceFilePlayer.cpp:179:9: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

          real_vars_[i] = 0.0;
          ^

• src/OSMPTraceFilePlayer.cpp:185:9: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

          string_vars_[i] = "";
          ^

• src/OSMPTraceFilePlayer.cpp:191:34: warning: [readability-convert-member-functions-to-static]

  method 'DoStart' can be made static

  fmi2Status COSMPTraceFilePlayer::DoStart(fmi2Boolean tolerance_defined, fmi2Real tolerance, fmi2Real start_time, fmi2Boolean stop_time_defined, fmi2Real stop_time)
                                   ^

• src/OSMPTraceFilePlayer.cpp:198:34: warning: [readability-convert-member-functions-to-static]

  method 'DoEnterInitializationMode' can be made static

  fmi2Status COSMPTraceFilePlayer::DoEnterInitializationMode()
                                   ^

• src/OSMPTraceFilePlayer.cpp:205:34: warning: [readability-convert-member-functions-to-static]

  method 'DoExitInitializationMode' can be made static

  fmi2Status COSMPTraceFilePlayer::DoExitInitializationMode()
                                   ^

• src/OSMPTraceFilePlayer.cpp:346:34: warning: [readability-convert-member-functions-to-static]

  method 'DoTerm' can be made static

  fmi2Status COSMPTraceFilePlayer::DoTerm()
                                   ^

• src/OSMPTraceFilePlayer.cpp:352:28: warning: [readability-convert-member-functions-to-static]

  method 'DoFree' can be made static

  void COSMPTraceFilePlayer::DoFree()
                             ^

• src/OSMPTraceFilePlayer.cpp:361:1: warning: [cppcoreguidelines-pro-type-member-init]

  constructor does not initialize these fields: boolean_vars_, integer_vars_, real_vars_

  COSMPTraceFilePlayer::COSMPTraceFilePlayer(fmi2String theinstance_name,
  ^

• src/OSMPTraceFilePlayer.cpp:376:5: warning: [cppcoreguidelines-prefer-member-initializer]

  'current_buffer_' should be initialized in a member initializer of the constructor

      current_buffer_ = new string();
      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

• src/OSMPTraceFilePlayer.cpp:377:5: warning: [cppcoreguidelines-prefer-member-initializer]

  'last_buffer_' should be initialized in a member initializer of the constructor

      last_buffer_ = new string();
      ^~~~~~~~~~~~~~~~~~~~~~~~~~~~

• src/OSMPTraceFilePlayer.cpp:510:24: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              value[i] = real_vars_[vr[i]];
                         ^

• src/OSMPTraceFilePlayer.cpp:527:24: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              value[i] = integer_vars_[vr[i]];
                         ^

• src/OSMPTraceFilePlayer.cpp:544:24: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              value[i] = boolean_vars_[vr[i]];
                         ^

• src/OSMPTraceFilePlayer.cpp:561:24: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              value[i] = string_vars_[vr[i]].c_str();
                         ^

• src/OSMPTraceFilePlayer.cpp:578:13: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              real_vars_[vr[i]] = value[i];
              ^

• src/OSMPTraceFilePlayer.cpp:595:13: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              integer_vars_[vr[i]] = value[i];
              ^

• src/OSMPTraceFilePlayer.cpp:612:13: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              boolean_vars_[vr[i]] = value[i];
              ^

• src/OSMPTraceFilePlayer.cpp:629:13: warning: [cppcoreguidelines-pro-bounds-constant-array-index]

  do not use array subscript when the index is not an integer constant expression

              string_vars_[vr[i]] = value[i];
              ^

• src/OSMPTraceFilePlayer.h:81:7: warning: [cppcoreguidelines-special-member-functions]

  class 'COSMPTraceFilePlayer' defines a non-default destructor but does not define a copy constructor, a copy assignment operator, a move constructor or a move assignment operator

  class COSMPTraceFilePlayer
        ^

• src/OSMPTraceFilePlayer.h:132:17: warning: [readability-identifier-naming]

  invalid case style for class method 'fmi_verbose_log_global'

      static void fmi_verbose_log_global(const char* format, ...)
                  ^~~~~~~~~~~~~~~~~~~~~~
                  FmiVerboseLogGlobal

• src/OSMPTraceFilePlayer.h:219:12: warning: [readability-identifier-naming]

  invalid case style for struct 'file_extension_is'

      struct file_extension_is
             ^~~~~~~~~~~~~~~~~
             FileExtensionIs

Have any feedback or feature suggestions? Share it here.