[Bindings] Add ExecParams bindings

Signed-off-by: Jean-Nicolas Brunet <[email protected]>

Author: jnbrunet

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_ExecParams.cpp

@@ -0,0 +1,53 @@
+/******************************************************************************
+*                              SofaPython3 plugin                             *
+*                  (c) 2021 CNRS, University of Lille, INRIA                  *
+*                                                                             *
+* This program is free software; you can redistribute it and/or modify it     *
+* under the terms of the GNU Lesser General Public License as published by    *
+* the Free Software Foundation; either version 2.1 of the License, or (at     *
+* your option) any later version.                                             *
+*                                                                             *
+* This program is distributed in the hope that it will be useful, but WITHOUT *
+* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
+* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
+* for more details.                                                           *
+*                                                                             *
+* You should have received a copy of the GNU Lesser General Public License    *
+* along with this program. If not, see <http://www.gnu.org/licenses/>.        *
+*******************************************************************************
+* Contact information: [email protected]                             *
+******************************************************************************/
+
+#include <SofaPython3/Sofa/Core/Binding_ExecParams.h>
+#include <sofa/core/ExecParams.h>
+
+namespace py { using namespace pybind11; }
+
+namespace sofapython3 {
+
+void moduleAddExecParams(py::module& m) {
+    using namespace sofa::core;
+    py::class_<ExecParams> c (m, "ExecParams", "Class gathering parameters use by most components methods, and transmitted by all visitors");
+    c.def(py::init());
+
+    py::enum_<ExecParams::ExecMode> (c, "ExecMode")
+        .value("EXEC_NONE", ExecParams::ExecMode::EXEC_NONE)
+        .value("EXEC_DEFAULT", ExecParams::ExecMode::EXEC_DEFAULT)
+        .value("EXEC_DEBUG", ExecParams::ExecMode::EXEC_DEBUG)
+        .value("EXEC_GPU", ExecParams::ExecMode::EXEC_GPU)
+        .value("EXEC_GRAPH", ExecParams::ExecMode::EXEC_GRAPH)
+        .export_values()
+    ;
+
+    // Public properties/methods
+    c.def("checkValidStorage", &ExecParams::checkValidStorage);
+    c.def("execMode", &ExecParams::execMode, "Mode of execution requested");
+    c.def("threadID", &ExecParams::threadID, "Index of current thread (0 corresponding to the only thread in sequential mode, or first thread in parallel mode)");
+    c.def("nbThreads", &ExecParams::nbThreads, "Number of threads currently known to Sofa");
+    c.def("update", &ExecParams::update, "Make sure this instance is up-to-date relative to the current thread");
+    c.def("setExecMode", &ExecParams::setExecMode, "Request a specific mode of execution");
+    c.def("setThreadID", &ExecParams::setThreadID, "Specify the index of the current thread");
+
+}
+
+} // namespace sofapython3

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_ExecParams.h

@@ -0,0 +1,28 @@
+/******************************************************************************
+*                              SofaPython3 plugin                             *
+*                  (c) 2021 CNRS, University of Lille, INRIA                  *
+*                                                                             *
+* This program is free software; you can redistribute it and/or modify it     *
+* under the terms of the GNU Lesser General Public License as published by    *
+* the Free Software Foundation; either version 2.1 of the License, or (at     *
+* your option) any later version.                                             *
+*                                                                             *
+* This program is distributed in the hope that it will be useful, but WITHOUT *
+* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
+* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
+* for more details.                                                           *
+*                                                                             *
+* You should have received a copy of the GNU Lesser General Public License    *
+* along with this program. If not, see <http://www.gnu.org/licenses/>.        *
+*******************************************************************************
+* Contact information: [email protected]                             *
+******************************************************************************/
+
+#pragma once
+#include <pybind11/pybind11.h>
+
+namespace sofapython3 {
+
+void moduleAddExecParams(pybind11::module &m);
+
+} /// namespace sofapython3

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_MechanicalParams.cpp

@@ -28,7 +28,7 @@ namespace sofapython3 {
 
 void moduleAddMechanicalParams(py::module& m) {
     using namespace sofa::core;
-    py::class_<MechanicalParams> c (m, "MechanicalParams", doc::mechanicalparams::MechanicalParamsClass);
+    py::class_<MechanicalParams, ExecParams> c (m, "MechanicalParams", doc::mechanicalparams::MechanicalParamsClass);
     c.def(py::init());
 
     // Dt

bindings/Sofa/src/SofaPython3/Sofa/Core/CMakeLists.txt

@@ -18,6 +18,7 @@ set(HEADER_FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_Controller_doc.h
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_DataEngine.h
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_DataEngine_doc.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/Binding_ExecParams.h
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_ForceField.h
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_ForceField_doc.h
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_ObjectFactory.h
@@ -63,6 +64,7 @@ set(SOURCE_FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/Data/Binding_DataString.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/Data/Binding_DataLink.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/Data/Binding_DataVectorString.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/Binding_ExecParams.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_ForceField.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_ObjectFactory.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/Binding_MechanicalParams.cpp

bindings/Sofa/src/SofaPython3/Sofa/Core/Submodule_Core.cpp

@@ -34,6 +34,7 @@ using sofa::helper::logging::Message;
 #include <SofaPython3/Sofa/Core/Binding_Context.h>
 #include <SofaPython3/Sofa/Core/Binding_Controller.h>
 #include <SofaPython3/Sofa/Core/Binding_DataEngine.h>
+#include <SofaPython3/Sofa/Core/Binding_ExecParams.h>
 #include <SofaPython3/Sofa/Core/Binding_ObjectFactory.h>
 #include <SofaPython3/Sofa/Core/Binding_MechanicalParams.h>
 #include <SofaPython3/Sofa/Core/Binding_MultiVecId.h>
@@ -135,6 +136,7 @@ PYBIND11_MODULE(Core, core)
     moduleAddContext(core);
     moduleAddController(core);
     moduleAddDataEngine(core);
+    moduleAddExecParams(core);
     moduleAddForceField(core);
     moduleAddObjectFactory(core);
     moduleAddMechanicalParams(core);