Merge pull request #33 from sofa-framework/add_addLink

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 if (py::isinstance<Base*>(value))
+        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

@@ -93,7 +93,7 @@ py::object BindingBase::GetAttr(Base* self, const std::string& s, bool doThrowEx
     /// Search if there is a link with the given name.
     /// If this is the case returns the corresponding python type.
     if(BaseLink* l = self->findLink(s))
-        return py::cast(l->getLinkedBase());
+        return py::cast(l);
 
     /// Search if we are quering for a 'magic' and private __data__ property
     /// this one allows to traverse all the data in the object
@@ -310,6 +310,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);
@@ -394,6 +399,12 @@ py::object BindingBase::getData(Base& self, const std::string& s)
     return py::none();
 }
 
+
+std::string BindingBase::getPathName(Base& self)
+{
+    return self.toBaseNode() ? self.toBaseNode()->getPathName() : self.toBaseObject()->getPathName();
+}
+    
 py::object BindingBase::setDataValues(Base& self, py::kwargs kwargs)
 {
     for(auto key : kwargs)
@@ -432,6 +443,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 = py::none(), "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);
@@ -440,6 +452,7 @@ void moduleAddBase(py::module &m)
     base.def("getLoggedMessagesAsString", &BindingBase::getLoggedMessagesAsString, sofapython3::doc::base::getLoggedMessagesAsString);
     base.def("countLoggedMessages", &BindingBase::countLoggedMessages, sofapython3::doc::base::countLoggedMessages);
     base.def("clearLoggedMessages", &BindingBase::clearLoggedMessages, sofapython3::doc::base::clearLoggedMessages);
+    base.def("getPathName", &BindingBase::getPathName);
     base.def("setDataValues", &BindingBase::setDataValues, sofapython3::doc::base::setDataValues);
 }
 

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
@@ -71,6 +72,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);
@@ -79,6 +81,7 @@ class BindingBase
     static py::object getLoggedMessagesAsString(Base& self);
     static py::object countLoggedMessages(Base& self);
     static py::object clearLoggedMessages(Base& self);
+    static std::string getPathName(Base& self);
 };
 
 

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

@@ -65,6 +65,13 @@ py::object getOwnerBase(BaseLink& self)
     return PythonFactory::toPython(self.getOwnerBase());
 }
 
+std::string getPathName(BaseLink& self)
+{
+    auto n = self.getOwnerBase()->toBaseNode();
+    auto o = self.getOwnerBase()->toBaseObject();
+    return (n ? n->getPathName() : o->getPathName()) + "." + self.getName();
+}
+
 void moduleAddBaseLink(py::module& m)
 {
     py::class_<BaseLink, std::unique_ptr<sofa::core::objectmodel::BaseLink, pybind11::nodelete>> link(m, "Link", sofapython3::doc::baseLink::baseLinkClass);
@@ -87,8 +94,11 @@ 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("getPathName", getPathName, sofapython3::doc::baseLink::getLinkedPath);
     link.def("read", &BaseLink::read, sofapython3::doc::baseLink::read);
 
 }

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

@@ -127,10 +127,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.