[Sofa.Core] Add getLinkPath() in the Base binding.

Author: damienmarchal

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

@@ -387,7 +387,13 @@ std::string BindingBase::getPathName(Base& self)
 {
     return self.toBaseNode() ? self.toBaseNode()->getPathName() : self.toBaseObject()->getPathName();
 }
-    
+
+std::string BindingBase::getLinkPath(Base& self)
+{
+    return "@"+getPathName(self);
+}
+
+
 py::object BindingBase::setDataValues(Base& self, py::kwargs kwargs)
 {
     for(auto key : kwargs)
@@ -435,7 +441,8 @@ 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("getPathName", &BindingBase::getPathName, sofapython3::doc::base::setDataValues);
+    base.def("getPathName", &BindingBase::getLinkPath, sofapython3::doc::base::setDataValues);
     base.def("setDataValues", &BindingBase::setDataValues, sofapython3::doc::base::setDataValues);
 }
 

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

@@ -64,6 +64,7 @@ class BindingBase
     static pybind11::object countLoggedMessages(sofa::core::objectmodel::Base& self);
     static pybind11::object clearLoggedMessages(sofa::core::objectmodel::Base& self);
     static std::string getPathName(sofa::core::objectmodel::Base& self);
+    static std::string getLinkPath(sofa::core::objectmodel::Base& self);
 };
 
 

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

@@ -63,6 +63,22 @@ static auto findData =
         :type name: string
         :return: the data field
         )";
+static auto getLinkPath =
+        R"(
+        returns the path name as a parsable string.
+        eg:
+            if object.getPathName() is "/child1/object"
+            then the linkPath is @"/child1/object"
+        )";
+static auto getPathName =
+        R"(
+        returns the path name as a string.
+        .. code-block:: python
+            a = Sofa.Core.Node("root")
+            b.addObject("Camera", name="camera")
+            b.getPathName() # should returns "/root/camera"
+        ```
+        )";
 static auto setDataValues =
         R"(
         Set values for a the given data field, multiple pairs of args are allowed.

bindings/Sofa/tests/Core/Base.py

@@ -123,7 +123,11 @@ def test_getTemplateName(self):
         c = root.addObject("MechanicalObject", name="t")
         self.assertEqual(c.getTemplateName(),"Vec3d")
 
-
+    def test_getLinkPath(self):
+        root = create_scene("root")
+        obj = root.addObject("MechanicalObject", name="obj")
+        self.assertEqual(obj.getPathName(),"/obj")
+        self.assertEqual(obj.getLinkPath(),"@/obj")
 
     def test_addExistingDataAsParentOfNewData(self):
         # TODO(@marques-bruno)