ENH: private controller class and related attributes

Author: MateusStano

rocketpy/__init__.py

@@ -22,7 +22,7 @@
     TankGeometry,
     UllageBasedTank,
 )
-from .control import Controller
+from .control import _Controller
 from .rocket import (
     AeroSurface,
     AirBrakes,

rocketpy/control/__init__.py

@@ -1 +1 @@
-from .controller import Controller
+from .controller import _Controller

rocketpy/control/controller.py

@@ -1,7 +1,7 @@
 from ..prints.controller_prints import _ControllerPrints
 
 
-class Controller:
+class _Controller:
     """A class for storing and running controllers on a rocket. Controllers
     have a controller function that is called at a specified sampling rate
     during the simulation. The controller function can access and modify

rocketpy/rocket/__init__.py

@@ -1,4 +1,4 @@
-from rocketpy.control.controller import Controller
+from rocketpy.control.controller import _Controller
 from rocketpy.rocket.aero_surface import (
     AeroSurface,
     AirBrakes,

rocketpy/rocket/rocket.py

@@ -2,7 +2,7 @@
 
 import numpy as np
 
-from rocketpy.control.controller import Controller
+from rocketpy.control.controller import _Controller
 from rocketpy.mathutils.function import Function
 from rocketpy.motors.motor import EmptyMotor
 from rocketpy.plots.rocket_plots import _RocketPlots
@@ -99,7 +99,7 @@ class Rocket:
         Collection of parachutes of the rocket.
     Rocket.air_brakes : list
         Collection of air brakes of the rocket.
-    Rocket.controllers : list
+    Rocket._controllers : list
         Collection of controllers of the rocket.
     Rocket.cp_position : Function
         Function of Mach number expressing the rocket's center of pressure
@@ -282,7 +282,7 @@ def __init__(
         self.parachutes = []
 
         # Controllers data initialization
-        self.controllers = []
+        self._controllers = []
 
         # AirBrakes data initialization
         self.air_brakes = []
@@ -811,7 +811,7 @@ def add_surfaces(self, surfaces, positions):
         self.evaluate_stability_margin()
         self.evaluate_static_margin()
 
-    def add_controllers(self, controllers):
+    def _add_controllers(self, controllers):
         """Adds a controller to the rocket.
 
         Parameters
@@ -826,9 +826,9 @@ def add_controllers(self, controllers):
         None
         """
         try:
-            self.controllers.extend(controllers)
+            self._controllers.extend(controllers)
         except TypeError:
-            self.controllers.append(controllers)
+            self._controllers.append(controllers)
 
     def add_tail(
         self, top_radius, bottom_radius, length, position, radius=None, name="Tail"
@@ -1280,15 +1280,15 @@ def add_air_brakes(
             deployment_level=0,
             name=name,
         )
-        controller = Controller(
+        controller = _Controller(
             interactable_objects=air_brakes,
             controller_function=controller_function,
             sampling_rate=sampling_rate,
             initial_observed_variables=initial_observed_variables,
             name=controller_name,
         )
         self.air_brakes.append(air_brakes)
-        self.add_controllers(controller)
+        self._add_controllers(controller)
         return air_brakes, controller
 
     def set_rail_buttons(

rocketpy/simulation/flight.py

@@ -50,7 +50,7 @@ class Flight:
         the beginning of the rail.
     Flight.name: str
         Name of the flight.
-    Flight.controllers : list
+    Flight._controllers : list
         List of controllers to be used during simulation.
     Flight.max_time : int, float
         Maximum simulation time allowed. Refers to physical time
@@ -584,7 +584,7 @@ def __init__(
         if self.rail_length <= 0:
             raise ValueError("Rail length must be a positive value.")
         self.parachutes = self.rocket.parachutes[:]
-        self.controllers = self.rocket.controllers[:]
+        self._controllers = self.rocket._controllers[:]
         self.inclination = inclination
         self.heading = heading
         self.max_time = max_time
@@ -660,7 +660,7 @@ def __init__(
                     self.parachutes, phase.t, phase.time_bound
                 )
                 phase.TimeNodes.add_controllers(
-                    self.controllers, phase.t, phase.time_bound
+                    self._controllers, phase.t, phase.time_bound
                 )
             # Add lst time node to permanent list
             phase.TimeNodes.add_node(phase.time_bound, [], [])
@@ -693,7 +693,7 @@ def __init__(
                 for callback in node.callbacks:
                     callback(self)
 
-                for controller in node.controllers:
+                for controller in node._controllers:
                     controller(self.t, self.y_sol, self.solution)
 
                 for parachute in node.parachutes:
@@ -3630,7 +3630,7 @@ def __init__(self, t, parachutes, controllers):
                 self.t = t
                 self.parachutes = parachutes
                 self.callbacks = []
-                self.controllers = controllers
+                self._controllers = controllers
 
             def __repr__(self):
                 return (