improve comments

Signed-off-by: Niklas Eiling <niklas.eiling@eonerc.rwth-aachen.de>
sogno-platform · Jul 30, 2024 · eab521a · eab521a
1 parent 1338ae2
commit eab521a
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git a/dpsim-models/include/dpsim-models/Attribute.h b/dpsim-models/include/dpsim-models/Attribute.h
@@ -353,7 +353,7 @@ class Attribute : public AttributeBase,
   AttributeBase::Ptr cloneValueOntoNewAttribute() override {
     return AttributePointer<AttributeBase>(
         AttributeStatic<T>::make(this->get()));
-    //TODO: This is in the real time path. We should not use heap here.
+    // TODO: This is in the real time path. We should not use heap here.
   };
 
   /**

diff --git a/dpsim-villas/examples/cxx/FpgaExample.cpp b/dpsim-villas/examples/cxx/FpgaExample.cpp
@@ -199,7 +199,8 @@ int main(int argc, char *argv[]) {
   Simulation sim(args.name, args);
   sim.setSystem(sys);
   sim.addInterface(intf);
-  //sim.addLogger(logger);
+  // If you want to add loggging (slows down the execution) add
+  // sim.addLogger(logger);
   sim.run();
 
   CPS::Logger::get("FpgaExample")->info("Simulation finished.");

diff --git a/dpsim-villas/src/InterfaceVillasQueueless.cpp b/dpsim-villas/src/InterfaceVillasQueueless.cpp
@@ -138,8 +138,8 @@ void InterfaceVillasQueueless::open() {
   createNode();
   createSignals();
 
-  mNode->getFactory()->start(
-      nullptr); //We have no SuperNode, so just hope type_start doesnt use it...
+  // We have no SuperNode, so just hope type_start doesn't use it...
+  mNode->getFactory()->start(nullptr);
 
   auto ret = mNode->start();
   if (ret < 0) {
@@ -343,17 +343,17 @@ void InterfaceVillasQueueless::writeToVillas() {
           "Failed to write samples to InterfaceVillas. Write returned code {}",
           ret);
 
-    /* Don't throw here, because we managed to send something */
+    // Don't throw here, because we managed to send something
   }
 }
 
 void InterfaceVillasQueueless::syncImports() {
-  //Block on read until all attributes with syncOnSimulationStart are read
+  // Block on read until all attributes with syncOnSimulationStart are read
   mSequenceToDpsim = this->readFromVillas();
 }
 
 void InterfaceVillasQueueless::syncExports() {
-  //Just push all the attributes
+  // Just push all the attributes
   this->writeToVillas();
 }
 

diff --git a/dpsim-villas/src/InterfaceWorkerVillas.cpp b/dpsim-villas/src/InterfaceWorkerVillas.cpp
@@ -289,14 +289,14 @@ void InterfaceWorkerVillas::readValuesFromEnv(
 
 void InterfaceWorkerVillas::writeValuesToEnv(
     std::vector<InterfaceQueued::AttributePacket> &updatedAttrs) {
-  //Update export sequence IDs
+  // Update export sequence IDs
   for (const auto &packet : updatedAttrs) {
     if (std::get<1>(mExports[packet.attributeId]) < packet.sequenceId) {
       std::get<1>(mExports[packet.attributeId]) = packet.sequenceId;
     }
   }
 
-  //Remove outdated packets
+  // Remove outdated packets
   auto beginOutdated = std::remove_if(
       updatedAttrs.begin(), updatedAttrs.end(), [this](auto packet) {
         return std::get<1>(mExports[packet.attributeId]) > packet.sequenceId;