documents possible motors and rockets

Author: GabrielBarberini

lib/models/motor.py

@@ -1,6 +1,11 @@
 from typing import Optional, Tuple
+from enum import Enum
 from pydantic import BaseModel
 
+class MotorOptions(str, Enum):
+    cesaroni = "Cesaroni_M1670"
+    custom = "Custom (Coming soon)"
+
 class Motor(BaseModel, frozen=True):
     burn_time: float
     dry_mass: float
@@ -13,7 +18,7 @@ class Motor(BaseModel, frozen=True):
     grain_initial_height: float
     grains_center_of_mass_position: float
     #TBD: thrust_source must be the id of a previously uploaded .eng file and a list of "default" files must be provided in the api docs
-    thrust_source: Optional[str] = "Cesaroni_M1670"
+    thrust_source: MotorOptions = MotorOptions.cesaroni
     grain_separation: float
     nozzle_radius: float
     throat_radius: float

lib/models/rocket.py

@@ -1,16 +1,21 @@
 from typing import Optional, Tuple
 from pydantic import BaseModel
+from enum import Enum
 from lib.models.motor import Motor
 from lib.models.aerosurfaces import Fins, NoseCone, Tail, RailButtons
 from lib.models.parachute import Parachute
 
+class RocketOptions(str, Enum):
+    calisto = "calisto"
+    custom = "Custom (Coming soon)"
+
 class Rocket(BaseModel, frozen=True):
     radius: float
     mass: float
     inertia: "Tuple[float, float, float]" = (6.321, 6.321, 0.0346)
     #TBD: powerOffDrag an powerOnDrag need to be the id of previously uploaded .csv files and a list of "default" files must be provided in the api docs
-    power_off_drag: Optional[str] = 'calisto'
-    power_on_drag: Optional[str] = 'calisto'
+    power_off_drag: RocketOptions = RocketOptions.calisto
+    power_on_drag: RocketOptions = RocketOptions.calisto
     center_of_mass_without_motor: int
     #TBD: a list of possible tailToNose values must be provided in the api docs
     coordinate_system_orientation: Optional[str] = "tail_to_nose"