SedInstance[Task]: return the elapsed time of an/all instance/s in milliseconds.

Author: agarny

src/api/libopencor/sedinstance.h

@@ -47,9 +47,11 @@ class LIBOPENCOR_EXPORT SedInstance: public Logger
      * @brief Run all the tasks associated with this instance.
      *
      * Run all the tasks associated with this instance.
+     *
+     * @return The elapsed time in milliseconds.
      */
 
-    void run();
+    double run();
 
     /**
      * @brief Return whether there are some tasks.

src/sed/sedinstance.cpp

@@ -72,19 +72,23 @@ SedInstance::Impl::Impl(const SedDocumentPtr &pDocument, bool pCompiled)
     }
 }
 
-void SedInstance::Impl::run()
+double SedInstance::Impl::run()
 {
     // Run all the tasks associated with this instance unless they have some issues.
 
+    auto res = 0.0;
+
     for (const auto &task : mTasks) {
         if (!task->hasIssues()) {
-            task->pimpl()->run();
+            res += task->pimpl()->run();
 
             if (task->hasIssues()) {
                 addIssues(task);
             }
         }
     }
+
+    return res;
 }
 
 bool SedInstance::Impl::hasTasks() const
@@ -131,9 +135,9 @@ const SedInstance::Impl *SedInstance::pimpl() const
     return reinterpret_cast<const Impl *>(Logger::pimpl());
 }
 
-void SedInstance::run()
+double SedInstance::run()
 {
-    pimpl()->run();
+    return pimpl()->run();
 }
 
 bool SedInstance::hasTasks() const

src/sed/sedinstance_p.h

@@ -31,7 +31,7 @@ class SedInstance::Impl: public Logger::Impl
 
     explicit Impl(const SedDocumentPtr &pDocument, bool pCompiled);
 
-    void run();
+    double run();
 
     bool hasTasks() const;
     size_t taskCount() const;

src/sed/sedinstancetask.cpp

@@ -174,8 +174,12 @@ void SedInstanceTask::Impl::initialise()
     }
 }
 
-void SedInstanceTask::Impl::run()
+double SedInstanceTask::Impl::run()
 {
+    // Start our timer.
+
+    auto startTime = std::chrono::high_resolution_clock::now();
+
     // (Re)initialise our model.
     // Note: reinitialise our model in case we are running our model multiple times.
 
@@ -224,7 +228,7 @@ void SedInstanceTask::Impl::run()
             if (!mOdeSolver->pimpl()->solve(mVoi, std::min(voiStart + static_cast<double>(++voiCounter) * voiInterval, voiEnd))) {
                 addIssues(mOdeSolver);
 
-                return;
+                return 0.0;
             }
 
 #ifndef __EMSCRIPTEN__
@@ -247,13 +251,17 @@ void SedInstanceTask::Impl::run()
             if ((mNlaSolver != nullptr) && mNlaSolver->hasIssues()) {
                 addIssues(mNlaSolver);
 
-                return;
+                return 0.0;
             }
 #endif
 
             trackResults(++index);
         }
     }
+
+    // Stop our timer and return the elapsed time in milliseconds.
+
+    return std::chrono::duration<double, std::milli>(std::chrono::high_resolution_clock::now() - startTime).count();
 }
 
 namespace {

src/sed/sedinstancetask_p.h

@@ -69,7 +69,7 @@ class SedInstanceTask::Impl: public Logger::Impl
     void trackResults(size_t pIndex);
 
     void initialise();
-    void run();
+    double run();
 
     Doubles voi() const;
     std::string voiName() const;