Made our SedInstance API more consistent.

Author: agarny

src/api/libopencor/file.h

@@ -189,7 +189,7 @@ class LIBOPENCOR_EXPORT File: public Logger
      *
      * Return the child file names. This method is only relevant for COMBINE archives.
      *
-     * @return The child file names, as a @c std::vector of @c std::string.
+     * @return The child file names, as a @ref Strings.
      */
 
     Strings childFileNames() const;
@@ -199,7 +199,7 @@ class LIBOPENCOR_EXPORT File: public Logger
      *
      * Return the child files. This method is only relevant for COMBINE archives.
      *
-     * @return The child files, as a @c std::vector of @ref FilePtr.
+     * @return The child files, as a @ref FilePtrs.
      */
 
     FilePtrs childFiles() const;

src/api/libopencor/seddocument.h

@@ -115,7 +115,7 @@ class LIBOPENCOR_EXPORT SedDocument: public Logger
      *
      * Return the models.
      *
-     * @return The models, as a @c std::vector of @ref SedModelPtr.
+     * @return The models, as a @ref SedModelPtrs.
      */
 
     SedModelPtrs models() const;
@@ -181,7 +181,7 @@ class LIBOPENCOR_EXPORT SedDocument: public Logger
      *
      * Return the simulations.
      *
-     * @return The simulations, as a @c std::vector of @ref SedSimulationPtr.
+     * @return The simulations, as a @ref SedSimulationPtrs.
      */
 
     SedSimulationPtrs simulations() const;
@@ -247,7 +247,7 @@ class LIBOPENCOR_EXPORT SedDocument: public Logger
      *
      * Return the tasks.
      *
-     * @return The tasks, as a @c std::vector of @ref SedAbstractTaskPtr.
+     * @return The tasks, as a @ref SedAbstractTaskPtrs.
      */
 
     SedAbstractTaskPtrs tasks() const;

src/api/libopencor/sedinstance.h

@@ -51,6 +51,26 @@ class LIBOPENCOR_EXPORT SedInstance: public Logger
 
     void run();
 
+    /**
+     * @brief Return whether there are some tasks.
+     *
+     * Return whether there are some tasks.
+     *
+     * @return @c true if there are some tasks, @c false otherwise.
+     */
+
+    bool hasTasks() const;
+
+    /**
+     * @brief Return the number of tasks.
+     *
+     * Return the number of tasks.
+     *
+     * @return The number of tasks.
+     */
+
+    size_t taskCount() const;
+
     /**
      * @brief Return the tasks.
      *
@@ -61,6 +81,18 @@ class LIBOPENCOR_EXPORT SedInstance: public Logger
 
     SedInstanceTaskPtrs tasks() const;
 
+    /**
+     * @brief Return the task at the given index.
+     *
+     * Return the task at the given index.
+     *
+     * @param pIndex The index of the task to return.
+     *
+     * @return The task as a @ref SedInstanceTaskPtr, if the index is valid, @c nullptr otherwise.
+     */
+
+    SedInstanceTaskPtr task(size_t pIndex) const;
+
 private:
     class Impl; /**< Forward declaration of the implementation class, @private. */
 

src/api/libopencor/sedinstancetask.h

@@ -95,7 +95,7 @@ class LIBOPENCOR_EXPORT SedInstanceTask: public Logger
      *
      * @param pIndex The index of the state.
      *
-     * @return The values of the state, as a @c std::vector of @c double, if the index is valid, an empty vector otherwise.
+     * @return The values of the state, as a @ref Doubles, if the index is valid, an empty vector otherwise.
      */
 
     Doubles state(size_t pIndex) const;
@@ -145,7 +145,7 @@ class LIBOPENCOR_EXPORT SedInstanceTask: public Logger
      *
      * @param pIndex The index of the rate.
      *
-     * @return The values of the rate, as a @c std::vector of @c double, if the index is valid, an empty vector otherwise.
+     * @return The values of the rate, as a @ref Doubles, if the index is valid, an empty vector otherwise.
      */
 
     Doubles rate(size_t pIndex) const;
@@ -195,7 +195,7 @@ class LIBOPENCOR_EXPORT SedInstanceTask: public Logger
      *
      * @param pIndex The index of the constant.
      *
-     * @return The values of the constant, as a @c std::vector of @c double, if the index is valid, an empty vector otherwise.
+     * @return The values of the constant, as a @ref Doubles, if the index is valid, an empty vector otherwise.
      */
 
     Doubles constant(size_t pIndex) const;
@@ -245,8 +245,7 @@ class LIBOPENCOR_EXPORT SedInstanceTask: public Logger
      *
      * @param pIndex The index of the computed constant.
      *
-     * @return The values of the computed constant, as a @c std::vector of @c double, if the index is valid, an empty
-     * vector otherwise.
+     * @return The values of the computed constant, as a @ref Doubles, if the index is valid, an empty vector otherwise.
      */
 
     Doubles computedConstant(size_t pIndex) const;
@@ -296,8 +295,7 @@ class LIBOPENCOR_EXPORT SedInstanceTask: public Logger
      *
      * @param pIndex The index of the algebraic variable.
      *
-     * @return The values of the algebraic variable, as a @c std::vector of @c double, if the index is valid, an empty
-     * vector otherwise.
+     * @return The values of the algebraic variable, as a @c Doubles, if the index is valid, an empty vector otherwise.
      */
 
     Doubles algebraic(size_t pIndex) const;

src/bindings/javascript/sed.cpp

@@ -68,7 +68,10 @@ void sedApi()
     emscripten::class_<libOpenCOR::SedInstance, emscripten::base<libOpenCOR::Logger>>("SedInstance")
         .smart_ptr<libOpenCOR::SedInstancePtr>("SedInstance")
         .function("run", &libOpenCOR::SedInstance::run)
-        .property("tasks", &libOpenCOR::SedInstance::tasks);
+        .property("hasTasks", &libOpenCOR::SedInstance::hasTasks)
+        .property("taskCount", &libOpenCOR::SedInstance::taskCount)
+        .property("tasks", &libOpenCOR::SedInstance::tasks)
+        .function("task", &libOpenCOR::SedInstance::task);
 
     // SedInstanceTask API.
 

src/bindings/python/sed.cpp

@@ -76,7 +76,10 @@ void sedApi(nb::module_ &m)
     nb::class_<libOpenCOR::SedInstance, libOpenCOR::Logger> sedInstance(m, "SedInstance");
 
     sedInstance.def("run", &libOpenCOR::SedInstance::run, "Run the tasks associated with this SedInstance object.")
-        .def_prop_ro("tasks", &libOpenCOR::SedInstance::tasks, "Return the tasks.");
+        .def_prop_ro("has_tasks", &libOpenCOR::SedInstance::hasTasks, "Return whether there are some tasks.")
+        .def_prop_ro("task_count", &libOpenCOR::SedInstance::taskCount, "Return the number of tasks.")
+        .def_prop_ro("tasks", &libOpenCOR::SedInstance::tasks, "Return the tasks.")
+        .def("task", &libOpenCOR::SedInstance::task, "Return the task.");
 
     // SedInstanceTask API.
 

src/sed/sedinstance.cpp

@@ -87,11 +87,30 @@ void SedInstance::Impl::run()
     }
 }
 
+bool SedInstance::Impl::hasTasks() const
+{
+    return !mTasks.empty();
+}
+
+size_t SedInstance::Impl::taskCount() const
+{
+    return mTasks.size();
+}
+
 SedInstanceTaskPtrs SedInstance::Impl::tasks() const
 {
     return mTasks;
 }
 
+SedInstanceTaskPtr SedInstance::Impl::task(size_t pIndex) const
+{
+    if (pIndex >= mTasks.size()) {
+        return {};
+    }
+
+    return mTasks[pIndex];
+}
+
 SedInstance::SedInstance(const SedDocumentPtr &pDocument, bool pCompiled)
     : Logger(new Impl(pDocument, pCompiled))
 {
@@ -117,9 +136,24 @@ void SedInstance::run()
     pimpl()->run();
 }
 
+bool SedInstance::hasTasks() const
+{
+    return pimpl()->hasTasks();
+}
+
+size_t SedInstance::taskCount() const
+{
+    return pimpl()->taskCount();
+}
+
 SedInstanceTaskPtrs SedInstance::tasks() const
 {
     return pimpl()->tasks();
 }
 
+SedInstanceTaskPtr SedInstance::task(size_t pIndex) const
+{
+    return pimpl()->task(pIndex);
+}
+
 } // namespace libOpenCOR

src/sed/sedinstance_p.h

@@ -33,7 +33,10 @@ class SedInstance::Impl: public Logger::Impl
 
     void run();
 
+    bool hasTasks() const;
+    size_t taskCount() const;
     SedInstanceTaskPtrs tasks() const;
+    SedInstanceTaskPtr task(size_t pIndex) const;
 };
 
 } // namespace libOpenCOR

tests/api/sed/coveragetests.cpp

@@ -289,6 +289,11 @@ TEST(CoverageSedTest, sedInstanceAndSedInstanceTask)
     auto instance = document->instantiate();
     auto instanceTask = instance->tasks()[0];
 
+    EXPECT_EQ(instance->hasTasks(), true);
+    EXPECT_EQ(instance->taskCount(), 1);
+    EXPECT_EQ(instance->task(0), instanceTask);
+    EXPECT_EQ(instance->task(1), nullptr);
+
     static const auto NoDoubles = std::vector<double> {};
 
     EXPECT_EQ(instanceTask->voi(), NoDoubles);

tests/bindings/javascript/sed.coverage.test.js

@@ -303,6 +303,11 @@ describe("Sed coverage tests", () => {
     const instance = document.instantiate();
     const instanceTask = instance.tasks.get(0);
 
+    expect(instance.hasTasks).toBe(true);
+    expect(instance.taskCount).toBe(1);
+    expect(instance.task(0)).toStrictEqual(instanceTask);
+    expect(instance.task(1)).toStrictEqual(null);
+
     expect(instanceTask.voi.size()).toBe(0);
     expect(instanceTask.voiAsArray).toStrictEqual([]);
     expect(instanceTask.voiName).toBe("environment/time");