Rename e0 to desired_direction

Author: schroedtert

python_bindings_jupedsim/generalized_centrifugal_force_model.cpp

@@ -17,7 +17,7 @@ void init_generalized_centrifugal_force_model(py::module_& m)
         m, "GeneralizedCentrifugalForceModelAgentParameters")
         .def(
             py::init([](double speed,
-                        std::tuple<double, double> e0,
+                        std::tuple<double, double> desired_direction,
                         std::tuple<double, double> position,
                         std::tuple<double, double> orientation,
                         JPS_JourneyId journey_id,
@@ -31,7 +31,7 @@ void init_generalized_centrifugal_force_model(py::module_& m)
                         double b_max) {
                 return JPS_GeneralizedCentrifugalForceModelAgentParameters{
                     speed,
-                    intoJPS_Point(e0),
+                    intoJPS_Point(desired_direction),
                     intoJPS_Point(position),
                     intoJPS_Point(orientation),
                     journey_id,
@@ -46,7 +46,7 @@ void init_generalized_centrifugal_force_model(py::module_& m)
             }),
             py::kw_only(),
             py::arg("speed"),
-            py::arg("e0"),
+            py::arg("desired_direction"),
             py::arg("position"),
             py::arg("orientation"),
             py::arg("journey_id"),
@@ -60,7 +60,7 @@ void init_generalized_centrifugal_force_model(py::module_& m)
             py::arg("b_max"))
         .def("__repr__", [](const JPS_GeneralizedCentrifugalForceModelAgentParameters& p) {
             return fmt::format(
-                "speed: {}, e0: {}, position: {}, orientation: {}, journey_id: {}, "
+                "speed: {}, desired_direction: {}, position: {}, orientation: {}, journey_id: {}, "
                 "stage_id: {}, mass: {}, desired_speed: {}, a_v: {}, a_min: {}, b_min: {}, b_max: "
                 "{}",
                 p.speed,
@@ -128,13 +128,14 @@ void init_generalized_centrifugal_force_model(py::module_& m)
                 JPS_GeneralizedCentrifugalForceModelState_SetSpeed(w.handle, speed);
             })
         .def_property(
-            "e0",
+            "desired_direction",
             [](const JPS_GeneralizedCentrifugalForceModelState_Wrapper& w) {
                 return intoTuple(JPS_GeneralizedCentrifugalForceModelState_GetE0(w.handle));
             },
             [](JPS_GeneralizedCentrifugalForceModelState_Wrapper& w,
-               std::tuple<double, double> e0) {
-                JPS_GeneralizedCentrifugalForceModelState_SetE0(w.handle, intoJPS_Point(e0));
+               std::tuple<double, double> desired_direction) {
+                JPS_GeneralizedCentrifugalForceModelState_SetE0(
+                    w.handle, intoJPS_Point(desired_direction));
             })
         .def_property(
             "mass",

python_modules/jupedsim/jupedsim/models/generalized_centrifugal_force.py

@@ -63,7 +63,7 @@ class GeneralizedCentrifugalForceModelAgentParameters:
 
     Attributes:
         speed: Speed of the agent.
-        e0: Desired direction of the agent.
+        desired_direction: Desired direction of the agent.
         position: Position of the agent.
         orientation: Orientation of the agent.
         journey_id: Id of the journey the agent follows.
@@ -78,7 +78,7 @@ class GeneralizedCentrifugalForceModelAgentParameters:
     """
 
     speed: float = 0.0
-    e0: tuple[float, float] = (0.0, 0.0)
+    desired_direction: tuple[float, float] = (0.0, 0.0)
     position: tuple[float, float] = (0.0, 0.0)
     orientation: tuple[float, float] = (1.0, 0.0)
     journey_id: int = -1
@@ -95,7 +95,7 @@ def __init__(
         self,
         *,
         speed: float = 0.0,
-        e0: tuple[float, float] = (0.0, 0.0),
+        desired_direction: tuple[float, float] = (0.0, 0.0),
         position: tuple[float, float] = (0.0, 0.0),
         orientation: tuple[float, float] = (1.0, 0.0),
         journey_id: int = -1,
@@ -108,10 +108,11 @@ def __init__(
         b_min: float = 0.2,
         b_max: float = 0.4,
         v0=None,
+        e0=None,
     ):
         """Init dataclass to handle deprecated argument."""
         self.speed = speed
-        self.e0 = e0
+        self.desired_direction = desired_direction
         self.position = position
         self.orientation = orientation
         self.journey_id = journey_id
@@ -133,12 +134,32 @@ def __init__(
         else:
             self.desired_speed = desired_speed
 
+        if e0 is not None:
+            warnings.warn(
+                "'e0' is deprecated, use 'desired_direction' instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self.desired_direction = e0
+        else:
+            self.desired_direction = desired_direction
+
+    @property
+    @deprecated("deprecated, use 'desired_direction' instead.")
+    def e0(self) -> tuple[float, float]:
+        return self.desired_direction
+
+    @e0.setter
+    @deprecated("deprecated, use 'desired_direction' instead.")
+    def e0(self, e0):
+        self.desired_direction = e0
+
     def as_native(
         self,
     ) -> py_jps.GeneralizedCentrifugalForceModelAgentParameters:
         return py_jps.GeneralizedCentrifugalForceModelAgentParameters(
             speed=self.speed,
-            e0=self.e0,
+            desired_direction=self.desired_direction,
             position=self.position,
             orientation=self.orientation,
             journey_id=self.journey_id,
@@ -167,13 +188,24 @@ def speed(self, speed):
         self._obj.speed = speed
 
     @property
+    def desired_direction(self) -> float:
+        """desired direction of this agent."""
+        return self._obj.desired_direction
+
+    @desired_direction.setter
+    def desired_direction(self, desired_direction):
+        self._obj.desired_direction = desired_direction
+
+    @property
+    @deprecated("deprecated, use 'desired_direction' instead.")
     def e0(self) -> tuple[float, float]:
         """Desired direction of this agent."""
-        return self._obj.e0
+        return self._obj.desired_speed
 
     @e0.setter
+    @deprecated("deprecated, use 'desired_direction' instead.")
     def e0(self, e0):
-        self._obj.e0 = e0
+        self._obj.desired_speed = e0
 
     @property
     def tau(self) -> float:

systemtest/test_model_properties.py

@@ -330,8 +330,8 @@ def test_set_model_parameters_generalized_centrifugal_force_model(
     sim.agent(agent_id).model.speed = 2.0
     assert sim.agent(agent_id).model.speed == 2.0
 
-    sim.agent(agent_id).model.e0 = (3.0, -3.0)
-    assert sim.agent(agent_id).model.e0 == (3.0, -3.0)
+    sim.agent(agent_id).model.desired_direction = (3.0, -3.0)
+    assert sim.agent(agent_id).model.desired_direction == (3.0, -3.0)
 
     sim.agent(agent_id).model.tau = 4.0
     assert sim.agent(agent_id).model.tau == 4.0
@@ -355,6 +355,64 @@ def test_set_model_parameters_generalized_centrifugal_force_model(
     assert sim.agent(agent_id).model.b_max == 9.0
 
 
+def test_generalized_centrifugal_force_model_agent_paramters_e0_constructor_deprecated(
+    simulation_with_generalized_centrifugal_force_model,
+):
+    sim = simulation_with_generalized_centrifugal_force_model
+    wp = sim.add_waypoint_stage((10, 1), 0.5)
+    journey_id = sim.add_journey(jps.JourneyDescription([wp]))
+
+    with pytest.warns(
+        DeprecationWarning, match="deprecated, use 'desired_direction' instead"
+    ):
+        agent = jps.GeneralizedCentrifugalForceModelAgentParameters(
+            journey_id=journey_id, stage_id=wp, position=(1, 1), e0=(1, 2)
+        )
+        assert agent.desired_direction == (1, 2)
+
+
+def test_generalized_centrifugal_force_model_agent_paramters_e0_setter_deprecated(
+    simulation_with_generalized_centrifugal_force_model,
+):
+    sim = simulation_with_generalized_centrifugal_force_model
+    wp = sim.add_waypoint_stage((10, 1), 0.5)
+    journey_id = sim.add_journey(jps.JourneyDescription([wp]))
+
+    agent = jps.GeneralizedCentrifugalForceModelAgentParameters(
+        journey_id=journey_id,
+        stage_id=wp,
+        position=(1, 1),
+        desired_direction=(1, 2),
+    )
+
+    with pytest.warns(
+        DeprecationWarning, match="deprecated, use 'desired_direction' instead"
+    ):
+        agent.e0 = (2, 1)
+        assert agent.desired_direction == (2, 1)
+
+
+def test_generalized_centrifugal_force_model_agent_paramters_e0_getter_deprecated(
+    simulation_with_generalized_centrifugal_force_model,
+):
+    sim = simulation_with_generalized_centrifugal_force_model
+    wp = sim.add_waypoint_stage((10, 1), 0.5)
+    journey_id = sim.add_journey(jps.JourneyDescription([wp]))
+
+    agent = jps.GeneralizedCentrifugalForceModelAgentParameters(
+        journey_id=journey_id,
+        stage_id=wp,
+        position=(1, 1),
+        desired_direction=(1, 2),
+    )
+
+    with pytest.warns(
+        DeprecationWarning, match="deprecated, use 'desired_direction' instead"
+    ):
+        desired_direction = agent.e0
+        assert desired_direction == (1, 2)
+
+
 @pytest.fixture
 def simulation_with_social_force_model_body_force():
     with pytest.warns(