Refactor Simulink Core API Parameter & fix precommit-ci & update clang-format

Author: wissem01chiha

IO/Core/SimulinkArrayWriter.cxx

@@ -1,6 +1,7 @@
 #include "SimulinkArrayWriter.h"
 #include "DataObject.h"
 #include "SimulinkArray.h"
+#include "ErrorCode.h"
 
 namespace slxio
 {

IO/Core/SimulinkWriter.h

@@ -8,58 +8,42 @@
 #include "ApiExportMacro.h"
 #include "PlatformTypes.h"
 
-class DataObject;
-class Logger;
-
 namespace slxio
 {
 SLXIO_ABI_NAMESPACE_BEGIN
 
+class DataObject;
+class Logger;
+
 /**
  * @class SimulinkWriter
  * @brief Abstract class to write Simulink data to files
  */
 class SLXIO_APIEXPORT SimulinkWriter
 {
 public:
-  /**
-   * Create a new instance of the writer
-   */
+  /** Create a new instance of the writer */
   virtual SimulinkWriter* New() = 0;
 
-  /**
-   * Virtual destructor for cleanup
-   */
+  /** Virtual destructor for cleanup */
   virtual ~SimulinkWriter() = default;
 
-  /**
-   * Write the current input data to output
-   */
+  /** Write the current input data to output */
   virtual ReturnType Write() = 0;
 
-  /**
-   * Set single input data object for writing
-   */
+  /** Set single input data object for writing */
   virtual ReturnType SetInputData(const DataObject& data) = 0;
 
-  /**
-   * Set indexed input data object for writing
-   */
+  /** Set indexed input data object for writing */
   virtual ReturnType SetInputData(IdType idx, const DataObject& data) = 0;
 
-  /**
-   * Get the single input data object
-   */
+  /** Get the single input data object*/
   DataObject* GetInputData() const;
 
-  /**
-   * Get the indexed input data object
-   */
+  /** Get the indexed input data object */
   DataObject* GetInputData(IdType idx) const;
 
-  /**
-   * Access the logger instance
-   */
+  /** Access the logger instance*/
   Logger& GetLogger();
 
 protected:

Simulink/Configuration/SimulinkConfigSet.cxx

@@ -17,13 +17,13 @@ SimulinkConfigSet::SimulinkConfigSet()
   , hardware(nullptr)
   , modelReference(nullptr)
   , rtw(nullptr)
-  , l(Logger::GetInstance())
+  , logger(Logger::GetInstance())
 {
 }
 
 SimulinkConfigSet::SimulinkConfigSet(const SimulinkObject& obj)
   : object(std::make_shared<SimulinkObject>(obj))
-  , l(Logger::GetInstance())
+  , logger(Logger::GetInstance())
 {
 }
 
@@ -42,34 +42,34 @@ const char* SimulinkConfigSet::getParameter(const char* name)
 
   if (name == nullptr)
   {
-    // l.log(Logger::V_ERROR, "SimulinkConfigSet parameter name null");
+    // logger.log(Logger::V_ERROR, "SimulinkConfigSet parameter name null");
     return "";
   }
-  std::shared_ptr<SimulinkParameter> cfgParam = getParameterObject(std::string(name));
-  return cfgParam->getValue();
+  std::shared_ptr<SimulinkParameterBase> cfgParam = getParameterObject(std::string(name));
+  return cfgParam->ToString().c_str();
 }
 
-std::shared_ptr<SimulinkParameter> SimulinkConfigSet::getParameterObject(const std::string& name)
+std::shared_ptr<SimulinkParameterBase> SimulinkConfigSet::getParameterObject(const std::string& name)
 {
-  auto param = object->getParameter(name);
+  auto param = object->GetParameter(name);
   if (param)
   {
     return param;
   }
-  // l.log(Logger::V_WARNING, "SimulinkConfigSet Parameter ", name,
+  // logger.log(Logger::V_WARNING, "SimulinkConfigSet Parameter ", name,
   //  " not found in configuration set.");
   return nullptr;
 }
 
 ReturnType SimulinkConfigSet::setParameter(const char* name, const char* value)
 {
-  auto param = object->getParameter(std::string(name));
+  auto param = object->GetParameter(std::string(name));
   if (param)
   {
-    param->setValue(value);
+    //param->SetValue(value);
     return E_OK;
   }
-  // l.log(Logger::V_WARNING, "SimulinkConfigSet Parameter ", name,
+  // logger.log(Logger::V_WARNING, "SimulinkConfigSet Parameter ", name,
   //" not found in configuration set. Cannot set value.");
   return E_OK;
 }
@@ -101,7 +101,7 @@ ReturnType SimulinkConfigSet::detach(SimulinkModel& model)
 
 std::string SimulinkConfigSet::getName()
 {
-  return object->getName();
+  return object->GetName();
 }
 
 std::shared_ptr<SimulinkObject> SimulinkConfigSet::getObject() const
@@ -133,7 +133,7 @@ void SimulinkConfigSet::activate()
 {
   if (status)
   {
-    // l.log(Logger::V_INFO, "Activating Simulink configuration set ",
+    // logger.log(Logger::V_INFO, "Activating Simulink configuration set ",
     //   object->getName());
   }
   status = true;
@@ -143,7 +143,7 @@ void SimulinkConfigSet::deactivate()
 {
   if (!status)
   {
-    // l.log(Logger::V_INFO, "Deactivating Simulink configuration set ",
+    // logger.log(Logger::V_INFO, "Deactivating Simulink configuration set ",
     //  object->getName());
   }
   status = false;

Simulink/Configuration/SimulinkConfigSet.h

@@ -9,11 +9,15 @@
 #include "PlatformTypes.h"
 #include "SimulinkModel.h"
 #include "SimulinkObject.h"
-#include "SimulinkParameter.h"
+#include "SimulinkParameterBase.h"
 #include <memory>
 #include <string>
 #include <vector>
 
+namespace slxio
+{
+SLXIO_ABI_NAMESPACE_BEGIN
+
 class SimulinkSolver;
 class SimulinkOptimization;
 class SimulinkSFSim;
@@ -23,20 +27,15 @@ class SimulinkModelReference;
 class SimulinkRTW;
 class Logger;
 
-namespace slxio
-{
-SLXIO_ABI_NAMESPACE_BEGIN
-
 /**
  * @brief SimulinkConfigSet represents a configuration set in a Simulink model
  */
 class SLXIO_APIEXPORT SimulinkConfigSet final
 {
 public:
+  /** Default Constructor */
   SimulinkConfigSet();
 
-  ~SimulinkConfigSet() = default;
-
   /// @brief disbale copy constructor
   /// @note instead use clone to create a copy of the configuration set
   SimulinkConfigSet(const SimulinkConfigSet&);
@@ -53,7 +52,7 @@ class SLXIO_APIEXPORT SimulinkConfigSet final
   const char* getParameter(const char* name);
 
   /// @brief Retuens the parameter object by name.
-  std::shared_ptr<SimulinkParameter> getParameterObject(const std::string& name);
+  std::shared_ptr<SimulinkParameterBase> getParameterObject(const std::string& name);
 
   /// @brief Sets a parameter value by name.
   ReturnType setParameter(const char* name, const char* value);
@@ -106,8 +105,10 @@ class SLXIO_APIEXPORT SimulinkConfigSet final
   /// @brief Get a Pointer to Solver Configuration struct
   std::shared_ptr<SimulinkSolver> getSolver();
 
+  /** Default destructor */
+  ~SimulinkConfigSet() = default;
 private:
-  Logger& l;
+  Logger& logger;
   bool status = false;
   std::shared_ptr<SimulinkObject> object;
   std::shared_ptr<SimulinkSolver> solver;

Simulink/Core/SimulinkArray.cxx

@@ -1,4 +1,5 @@
 #include "SimulinkArray.h"
+#include "ErrorCode.h"
 #include "Logger.h"
 #include "SimulinkParameter.h"
 #include <algorithm>
@@ -86,7 +87,7 @@ ReturnType SimulinkArray::Insert(const std::shared_ptr<SimulinkElementBase>& ele
 
     for (const auto& arraysPtr : SubArrays)
     {
-      if (subArrayPtr->GetArrayName() == arraysPtr->GetArrayName())
+      if (subArrayPtr->GetName() == arraysPtr->GetName())
       {
         logger.SendLogMessage({ Logger::LOG, Logger::LOG_WARN, SimulinkArrayLogApp, 3 },
           { "SubArray already exists in the base array" });
@@ -160,7 +161,7 @@ ReturnType SimulinkArray::Erase(const std::shared_ptr<SimulinkElementBase>& elem
     for (const auto& arr : SubArrays)
     {
 
-      if (arr->GetArrayName() == arrayPtr->GetArrayName())
+      if (arr->GetName() == arrayPtr->GetName())
       {
         SubArrays.erase(remove(SubArrays.begin(), SubArrays.end(), arr), SubArrays.end());
         return E_OK;
@@ -255,12 +256,12 @@ Logger& SimulinkArray::GetLogger()
   return logger;
 }
 
-std::shared_ptr<SimulinkParameter> SimulinkArray::GetArrayParameter(std::string ArrayName)
+std::shared_ptr<SimulinkParameterBase> SimulinkArray::GetParameter(std::string name)
 {
 
   for (const auto& param : ArrayParameters)
   {
-    if (param && param->getName() == ArrayName)
+    if (param && param->GetName() == name)
     {
       return param;
     }
@@ -270,7 +271,7 @@ std::shared_ptr<SimulinkParameter> SimulinkArray::GetArrayParameter(std::string
   {
     if (SubArray)
     {
-      auto result = SubArray->GetArrayParameter(ArrayName);
+      auto result = SubArray->GetParameter(name);
       if (result)
       {
         return result;
@@ -282,12 +283,23 @@ std::shared_ptr<SimulinkParameter> SimulinkArray::GetArrayParameter(std::string
   return nullptr;
 }
 
-std::string SimulinkArray::GetArrayName()
+ReturnType SimulinkArray::SetParameter(
+  std::string name, std::shared_ptr<SimulinkParameterBase> parameter)
+{
+  return E_OK;
+}
+
+ReturnType SimulinkArray::AddParameter(std::shared_ptr<SimulinkParameterBase> parameter)
+{
+  return E_OK;
+}
+
+std::string SimulinkArray::GetName()
 {
   return ArrayName;
 }
 
-std::string SimulinkArray::GetArrayDimension()
+std::string SimulinkArray::GetDimension()
 {
   return ArrayDimension;
 }

Simulink/Core/SimulinkArray.h

@@ -85,7 +85,14 @@ class SLXIO_APIEXPORT SimulinkArray final : public SimulinkElementBase
   std::string GetArrayType();
 
   /** Return the parameter with the given name. */
-  std::shared_ptr<SimulinkParameter> GetParameter(std::string name) override;
+  std::shared_ptr<SimulinkParameterBase> GetParameter(std::string name) override;
+
+  /** Sets the element specifc parameter to given one  */
+  ReturnType SetParameter(
+    std::string name, std::shared_ptr<SimulinkParameterBase> parameter) override;
+
+  /* Adds a Parameter to the array */
+  ReturnType AddParameter(std::shared_ptr<SimulinkParameterBase> parameter) override;
 
   /** Return the class logger. */
   Logger& GetLogger();

Simulink/Core/SimulinkAtomicSubsystem.cxx

@@ -25,13 +25,49 @@ std::string SimulinkAtomicSubsystem::ToString() const
   return std::string();
 }
 
+std::string SimulinkAtomicSubsystem::GetName()
+{
+  return std::string();
+}
+
+std::string SimulinkAtomicSubsystem::GetDimension()
+{
+  return std::string();
+}
+
+ReturnType SimulinkAtomicSubsystem::SetParameter(
+  std::string name, std::shared_ptr<SimulinkParameterBase> parameter)
+{
+  return E_OK;
+}
+
+ReturnType SimulinkAtomicSubsystem::AddParameter(std::shared_ptr<SimulinkParameterBase> parameter)
+{
+  return E_OK;
+}
+
 bool SimulinkAtomicSubsystem::Contains(const IdType& id) const
 {
   return false;
 }
 
 void SimulinkAtomicSubsystem::Clear() {}
 
+ReturnType SimulinkAtomicSubsystem::Insert(const std::shared_ptr<SimulinkElementBase>& element)
+{
+  return E_OK;
+}
+
+ReturnType SimulinkAtomicSubsystem::Erase(const IdType& id)
+{
+  return ReturnType();
+}
+
+ReturnType SimulinkAtomicSubsystem::Erase(const std::shared_ptr<SimulinkElementBase>& element)
+{
+  return ReturnType();
+}
+
 std::shared_ptr<SimulinkElementBase> SimulinkAtomicSubsystem::at(IdType index)
 {
   return std::shared_ptr<SimulinkElementBase>();