Enhance ThrustVectorActuator2D with serialization methods and improve documentation

Author: zuorenchen

rocketpy/rocket/actuator/thrust_vector.py

@@ -184,7 +184,7 @@ def __init__(
         Parameters
         ----------
         name : str, optional
-            Name of the dual-axis thrust vector actuator. Default is "Thrust Vector Control".
+            Name of the dual-axis thrust vector actuator. Default is "Thrust Vector Control (X/Y)-axis".
         demand_rate : int, optional
             Demand rate of the dual-axis thrust vector actuator in Hz. Default is 100 Hz.
             None indicates a continuous-time actuator.
@@ -201,19 +201,20 @@ def __init__(
             exceeds the maximum value. Default is True.
         initial_gimbal_angle : float, optional
             Initial gimbal angle in deg. Default is 0.0 (no gimbal).
-        roll_torque_time_constant : float, optional
-            Time constant for the roll torque actuator dynamics (first-order IIR
+        gimbal_time_constant : float, optional
+            Time constant for the gimbal actuator dynamics (first-order IIR
             filter) in seconds. If None, no actuator dynamics are applied.
-            Must be non-negative. Default is None. demand_rate must be specified if roll_torque_time_constant is not None.
+            Must be non-negative. Default is None. demand_rate must be specified if gimbal_time_constant is not None.
 
 
         Returns
         -------
         None
         """
+        self.name = name
 
         self.x = ThrustVectorActuator(
-            name=name + " X-axis",
+            name=self.name + " X-axis",
             demand_rate=demand_rate,
             max_gimbal_angle=max_gimbal_angle,
             gimbal_rate_limit=gimbal_rate_limit,
@@ -222,7 +223,7 @@ def __init__(
             gimbal_time_constant=gimbal_time_constant,
         )
         self.y = ThrustVectorActuator(
-            name=name + " Y-axis",
+            name=self.name + " Y-axis",
             demand_rate=demand_rate,
             max_gimbal_angle=max_gimbal_angle,
             gimbal_rate_limit=gimbal_rate_limit,
@@ -233,7 +234,7 @@ def __init__(
 
     @property
     def gimbal_angle_x(self):
-        """Returns the current gimbal angle around the y-axis (yaw)."""
+        """Returns the current gimbal angle around the x-axis (pitch)."""
         return self.x.gimbal_angle
 
     @gimbal_angle_x.setter
@@ -267,3 +268,45 @@ def gimbal_angles(self, value):
         """
         self.gimbal_angle_x = value[0]
         self.gimbal_angle_y = value[1]
+
+    def info(self):
+        """Prints summarized information of the thrust vector actuator.
+
+        Returns
+        -------
+        None
+        """
+        self.x.info()
+        self.y.info()
+
+    def all_info(self):
+        """Prints all information of the thrust vector actuator.
+
+        Returns
+        -------
+        None
+        """
+        self.info()
+
+    def to_dict(self, **kwargs):  # pylint: disable=unused-argument
+        return {
+            "name": self.name,
+            "demand_rate": self.x.demand_rate,
+            "max_gimbal_angle": self.x.actuator_range[1],
+            "gimbal_rate_limit": self.x.actuator_rate_limit,
+            "clamp": self.x.clamp,
+            "initial_gimbal_angle": self.x.actuator_initial_output,
+            "gimbal_time_constant": self.x.actuator_time_constant,
+        }
+
+    @classmethod
+    def from_dict(cls, data):
+        return cls(
+            name=data.get("name"),
+            demand_rate=data.get("demand_rate"),
+            max_gimbal_angle=data.get("max_gimbal_angle"),
+            gimbal_rate_limit=data.get("gimbal_rate_limit"),
+            clamp=data.get("clamp"),
+            initial_gimbal_angle=data.get("initial_gimbal_angle"),
+            gimbal_time_constant=data.get("gimbal_time_constant"),
+        )

tests/unit/rocket/test_actuators.py

@@ -326,6 +326,89 @@ def test_clamping_individual_axes(self):
         actuator.y.actuator_output = -15.0
         assert actuator.gimbal_angle_y == -10.0
 
+    def test_to_dict(self):
+        """Test to_dict serialization for ThrustVectorActuator2D."""
+        actuator = ThrustVectorActuator2D(
+            name="Custom 2D TVC",
+            demand_rate=50,
+            max_gimbal_angle=8.0,
+            gimbal_rate_limit=3.0,
+            clamp=True,
+            initial_gimbal_angle=2.0,
+            gimbal_time_constant=0.1,
+        )
+        data = actuator.to_dict()
+        assert data["name"] == "Custom 2D TVC"
+        assert data["demand_rate"] == 50
+        assert data["max_gimbal_angle"] == 8.0
+        assert data["gimbal_rate_limit"] == 3.0
+        assert data["clamp"] is True
+        assert data["initial_gimbal_angle"] == 2.0
+        assert data["gimbal_time_constant"] == 0.1
+
+    def test_from_dict(self):
+        """Test from_dict deserialization for ThrustVectorActuator2D."""
+        data = {
+            "name": "Test 2D TVC",
+            "demand_rate": 75,
+            "max_gimbal_angle": 12.0,
+            "gimbal_rate_limit": 4.0,
+            "clamp": False,
+            "initial_gimbal_angle": 3.0,
+            "gimbal_time_constant": 0.2,
+        }
+        actuator = ThrustVectorActuator2D.from_dict(data)
+        assert actuator.x.name == "Test 2D TVC X-axis"
+        assert actuator.y.name == "Test 2D TVC Y-axis"
+        assert actuator.x.demand_rate == 75
+        assert actuator.y.demand_rate == 75
+        assert actuator.gimbal_angles == (3.0, 3.0)
+        assert actuator.x.actuator_range == (-12.0, 12.0)
+
+    def test_from_dict_roundtrip(self):
+        """Test roundtrip serialization/deserialization."""
+        original = ThrustVectorActuator2D(
+            name="Roundtrip Test",
+            demand_rate=60,
+            max_gimbal_angle=9.0,
+            gimbal_rate_limit=2.5,
+            clamp=True,
+            initial_gimbal_angle=1.5,
+            gimbal_time_constant=0.15,
+        )
+        data = original.to_dict()
+        reconstructed = ThrustVectorActuator2D.from_dict(data)
+        assert reconstructed.x.name == original.x.name
+        assert reconstructed.x.demand_rate == original.x.demand_rate
+        assert reconstructed.gimbal_angles == original.gimbal_angles
+
+    def test_info_methods(self):
+        """Test info and all_info methods for ThrustVectorActuator2D."""
+        actuator = ThrustVectorActuator2D(
+            name="Test 2D TVC",
+            max_gimbal_angle=10.0,
+            initial_gimbal_angle=2.0,
+        )
+        # These should not raise exceptions
+        actuator.info()
+        actuator.all_info()
+
+    def test_info_methods_with_custom_parameters(self):
+        """Test info methods with custom gimbal angles."""
+        actuator = ThrustVectorActuator2D(
+            name="Custom Info Test",
+            demand_rate=200,
+            max_gimbal_angle=15.0,
+            gimbal_rate_limit=10.0,
+            initial_gimbal_angle=5.0,
+            gimbal_time_constant=0.05,
+        )
+        actuator.gimbal_angle_x = 7.5
+        actuator.gimbal_angle_y = -3.2
+        # These should not raise exceptions and reflect current state
+        actuator.info()
+        actuator.all_info()
+
 
 class TestActuatorDynamics:
     """Test suite for actuator dynamics (rate limiting, time constants)."""