ENH: first structure

Author: MateusStano

rocketpy/simulation/events.py

@@ -0,0 +1,100 @@
+class Event:
+    def __init__(self, trigger, action, name):
+        """Initializes an Event object.
+
+        Parameters
+        ----------
+        trigger : function
+            A function that takes the current state of the simulation as input and returns a boolean value. The event will be triggered when this function returns True.
+        action : function
+            A function that takes the current state of the simulation as input and performs some action when the event is triggered.
+        name : str
+            A name for the event, used for identification purposes.
+
+        """
+        self.trigger = trigger
+        self.action = action
+        self.name = name
+
+    # TODO: check_trigger does note receive enough arguments to substitute parachute events
+    def check_trigger(self, state):
+        """Checks if the event should be triggered based on the current state of the simulation.
+
+        Parameters
+        ----------
+        state : dict
+            The current state of the simulation, containing information such as altitude, velocity, and time.
+
+        Returns
+        -------
+        bool
+            True if the event should be triggered, False otherwise.
+
+        """
+        return self.trigger(state)
+
+    def execute_action(self, state):
+        """Executes the action associated with the event.
+
+        Parameters
+        ----------
+        state : dict
+            The current state of the simulation, containing information such as altitude, velocity, and time.
+
+        """
+        return self.action(state)
+
+    def __repr__(self):
+        # TODO: Implement a more informative string representation of the Event object.
+        pass
+
+    def __str__(self):
+        # TODO: Implement a more informative string representation of the Event object.
+        pass
+
+    def __call__(self, *args, **kwds):
+        # TODO: This should call the action (or the trigger?)
+        pass
+
+
+# TODO: Implement functions which are standard types of events, such as motor burnout events, landing events, etc.
+# def motor_burnout_trigger(state):
+#     """A trigger function that returns
+
+# # TODO: think about this
+# class ParachuteEvent(Event):
+
+
+#     def __init__(self, trigger, action, name, parachute):
+#         """Initializes a ParachuteEvent object.
+
+#         Parameters
+#         ----------
+#         trigger : function
+#             A function that takes the current state of the simulation as input and returns a boolean value. The event will be triggered when this function returns True.
+#         action : function
+#             A function that takes the current state of the simulation as input and performs some action when the event is triggered.
+#         name : str
+#             A name for the event, used for identification purposes.
+#         parachute : Parachute
+#             The parachute associated with this event.
+
+#         """
+#         super().__init__(trigger, action, name)
+#         self.parachute = parachute
+
+#     def apogee_trigger(state):
+#         """A trigger function that returns True when the rocket reaches apogee.
+
+#         Parameters
+#         ----------
+#         state : dict
+#             The current state of the simulation, containing information such as altitude, velocity, and time.
+
+#         Returns
+#         -------
+#         bool
+#             True if the rocket has reached apogee, False otherwise.
+
+#         """
+#         return state['velocity'] <= 0

rocketpy/simulation/flight.py

@@ -26,6 +26,7 @@
     quaternions_to_precession,
     quaternions_to_spin,
 )
+from .events import Event
 
 ODE_SOLVER_MAP = {
     "RK23": RK23,
@@ -617,6 +618,19 @@ def __init__(  # pylint: disable=too-many-arguments,too-many-statements
         self.simulation_mode = simulation_mode
         self.ode_solver = ode_solver
 
+        # Events
+        def out_of_rail_trigger(state):
+            return (
+                state[0] ** 2 + state[1] ** 2 + (state[2] - self.env.elevation) ** 2
+                >= self.effective_1rl**2
+            )
+
+        self.out_of_rail_event = Event(
+            trigger=out_of_rail_trigger,
+            action=self.__handle_out_of_rail_event,
+            name="Out of Rail Event",
+        )
+
         # Controller initialization
         self.__init_controllers()
 
@@ -1014,14 +1028,12 @@ def __check_simulation_events(self, phase, phase_index, node_index):
         bool
             True if an event occurred and the simulation should break.
         """
+        # TODO: make all these 3 events be handled with the Events class
         # Check for first out of rail event
-        if len(self.out_of_rail_state) == 1 and (
-            self.y_sol[0] ** 2
-            + self.y_sol[1] ** 2
-            + (self.y_sol[2] - self.env.elevation) ** 2
-            >= self.effective_1rl**2
+        if len(self.out_of_rail_state) == 1 and self.out_of_rail_event.trigger(
+            self.y_sol
         ):
-            return self.__handle_out_of_rail_event(phase, phase_index, node_index)
+            return self.out_of_rail_event.action(phase, phase_index, node_index)
 
         # Check for apogee event
         # TODO: negative vz doesn't really mean apogee. Improve this.