Add addLink method in Binding_Base to create links dynamically

Author: marques-bruno

Plugin/src/SofaPython3/DataHelper.cpp

@@ -35,6 +35,8 @@ along with sofaqtquick. If not, see <http://www.gnu.org/licenses/>.
 #include <SofaPython3/DataCache.h>
 #include <SofaPython3/PythonFactory.h>
 
+using sofa::core::objectmodel::BaseLink;
+
 namespace sofapython3
 {
 
@@ -597,5 +599,30 @@ BaseData* addData(py::object py_self, const std::string& name, py::object value,
     return data;
 }
 
+BaseLink* addLink(py::object py_self, const std::string& name, py::object value, const std::string& help)
+{
+    Base* self = py::cast<Base*>(py_self);
+    if (isProtectedKeyword(name))
+        throw py::value_error("addLink: Cannot call addLink with name " + name + ": Protected keyword");
+
+    checkAmbiguousCreation(py_self, name, "link");
+
+    BaseLink::InitLink<Base> initlink(self, name, help);
 
+    BaseLink* link = new sofa::core::objectmodel::SingleLink<Base, Base, BaseLink::FLAG_MULTILINK>(initlink);
+    if (py::isinstance<std::string>(value))
+    {
+        auto linkpath = py::cast<std::string>(value);
+        if (linkpath[0] != '@')
+            linkpath = "@" + linkpath;
+        if (!link->read(linkpath))
+            throw py::value_error("addLink: Cannot read link path " + linkpath + ": is link valid?");
+    }
+    else
+        link->setLinkedBase(py::cast<Base*>(value));
+
+//    self->addLink(link);
+    return link;
 }
+
+}  // namespace sofapython3

Plugin/src/SofaPython3/DataHelper.h

@@ -59,6 +59,7 @@ namespace py { using namespace pybind11; }
 
 using sofa::core::objectmodel::Base;
 using sofa::core::objectmodel::BaseData;
+using sofa::core::objectmodel::BaseLink;
 using sofa::core::objectmodel::BaseNode;
 using sofa::core::objectmodel::BaseObject;
 using sofa::defaulttype::AbstractTypeInfo;
@@ -189,6 +190,7 @@ class scoped_writeonly_access
 };
 
 SOFAPYTHON3_API BaseData* addData(py::object py_self, const std::string& name, py::object value = py::object(), py::object defaultValue = py::object(), const std::string& help = "", const std::string& group = "Property", std::string type = "");
+SOFAPYTHON3_API BaseLink* addLink(py::object py_self, const std::string& name, py::object value, const std::string& help);
 SOFAPYTHON3_API bool isProtectedKeyword(const std::string& name);
 
 }  // namespace sofapython3

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

@@ -311,6 +311,11 @@ BaseData* BindingBase::addData(py::object py_self, const std::string& name, py::
     return sofapython3::addData(py_self, name, value, defaultValue, help, group, type);
 }
 
+BaseLink* BindingBase::addLink(py::object py_self, const std::string& name, py::object value, const std::string& help)
+{
+    return sofapython3::addLink(py_self, name, value, help);
+}
+
 BaseData* BindingBase::addDataFromData(Base* self, py::object d)
 {
     BaseData* data = py::cast<BaseData*>(d);
@@ -420,6 +425,7 @@ void moduleAddBase(py::module &m)
     base.def("getLinks", &BindingBase::getLinks, pybind11::return_value_policy::reference, sofapython3::doc::base::getLinks);
     base.def("addData", &BindingBase::addData, "name"_a, "value"_a = py::none(), "default"_a = py::none(), "help"_a = "", "group"_a = "", "type"_a = "", sofapython3::doc::base::addData);
     base.def("addData", &BindingBase::addDataFromData, sofapython3::doc::base::addDataInitialized);
+    base.def("addLink", &BindingBase::addLink, "name"_a, "value"_a, "help"_a = "", sofapython3::doc::base::addLink);
     base.def("__getattr__", &BindingBase::__getattr__);
     base.def("__setattr__", &BindingBase::__setattr__);
     base.def("getData", &BindingBase::getData, sofapython3::doc::base::getData);

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

@@ -51,6 +51,7 @@ namespace py {
 using namespace pybind11::literals;
 using sofa::core::objectmodel::Base;
 using sofa::core::objectmodel::BaseData;
+using sofa::core::objectmodel::BaseLink;
 using sofa::core::sptr;
 
 class BindingBase
@@ -70,6 +71,7 @@ class BindingBase
     static py::list getLinks(Base& self);
     static BaseData* addData(py::object py_self, const std::string& name, py::object value = py::object(), py::object defaultValue = py::object(), const std::string& help = "", const std::string& group = "Property", std::string type = "");
     static BaseData* addDataFromData(Base* self, py::object d);
+    static BaseLink* addLink(py::object py_self, const std::string& name, py::object value, const std::string& help);
     static py::list __dir__(Base* self);
     static py::object __getattr__(py::object self, const std::string& s);
     static void __setattr__(py::object self, const std::string& s, py::object value);

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

@@ -87,6 +87,8 @@ void moduleAddBaseLink(py::module& m)
 
     link.def("getLinkedData", &BaseLink::getLinkedData, sofapython3::doc::baseLink::getLinkedData);
     link.def("getLinkedBase", getLinkedBase, "index"_a = 0, sofapython3::doc::baseLink::getLinkedBase);
+    link.def("setLinkedBase", &BaseLink::setLinkedBase, sofapython3::doc::baseLink::getLinkedBase);
+
 
     link.def("getLinkedPath", &BaseLink::getLinkedPath, "index"_a = 0, sofapython3::doc::baseLink::getLinkedPath);
     link.def("read", &BaseLink::read, sofapython3::doc::baseLink::read);

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

@@ -123,10 +123,24 @@ static auto addData =
         :type name: string
         :type value: object
         :type help: string
-        :type groupe: string
+        :type group: string
         :type type: string
         )";
 
+static auto addLink =
+        R"(
+        Create a Link to a SOFA component and adds it to the base.
+        Note that this method should only be called if the field was not initialized with the initLink method
+        :param self: the base itself
+        :param name: the name of the link to be added
+        :param value: the value from which the data can be created (either a pathname or a SofaBase)
+        :param help: help message that describes the link to be created
+        :type self: object
+        :type name: string
+        :type value: object
+        :type help: string
+        )";
+
 static auto addDataInitialized =
         R"(
         Add a data field.