editoast: move energy source to schemas

Author: Wadjetz

editoast/editoast_schemas/src/rolling_stock/energy_source.rs

@@ -0,0 +1,66 @@
+use serde::Deserialize;
+use serde::Serialize;
+use utoipa::ToSchema;
+
+// Energy sources schema
+
+/// energy source of a rolling stock
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
+#[serde(tag = "energy_source_type", deny_unknown_fields)]
+pub enum EnergySource {
+    /// energy source for a rolling stock representing a electrification
+    Electrification {
+        max_input_power: SpeedDependantPower,
+        max_output_power: SpeedDependantPower,
+        #[schema(minimum = 0, maximum = 1)]
+        efficiency: f64,
+    },
+    PowerPack {
+        max_input_power: SpeedDependantPower,
+        max_output_power: SpeedDependantPower,
+        energy_storage: EnergyStorage,
+        #[schema(minimum = 0, maximum = 1)]
+        efficiency: f64,
+    },
+    /// energy source for a rolling stock representing a battery
+    Battery {
+        max_input_power: SpeedDependantPower,
+        max_output_power: SpeedDependantPower,
+        energy_storage: EnergyStorage,
+        #[schema(minimum = 0, maximum = 1)]
+        efficiency: f64,
+    },
+}
+
+/// power-speed curve (in an energy source)
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
+#[serde(deny_unknown_fields)]
+pub struct SpeedDependantPower {
+    speeds: Vec<f64>,
+    powers: Vec<f64>,
+}
+
+/// energy storage of an energy source (of a rolling stock, can be a electrical battery or a hydrogen/fuel powerPack)
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
+#[serde(deny_unknown_fields)]
+pub struct EnergyStorage {
+    capacity: f64,
+    #[schema(minimum = 0, maximum = 1)]
+    soc: f64,
+    #[schema(minimum = 0, maximum = 1)]
+    soc_min: f64,
+    #[schema(minimum = 0, maximum = 1)]
+    soc_max: f64,
+    #[schema(required)]
+    refill_law: Option<RefillLaw>,
+}
+
+/// physical law defining how the storage can be refilled
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
+#[serde(deny_unknown_fields)]
+pub struct RefillLaw {
+    #[schema(minimum = 0)]
+    tau: f64,
+    #[schema(minimum = 0, maximum = 1)]
+    soc_ref: f64,
+}

editoast/editoast_schemas/src/rolling_stock/mod.rs

@@ -11,3 +11,9 @@ pub use effort_curves::RollingStockComfortType;
 
 mod rolling_resistance;
 pub use rolling_resistance::RollingResistance;
+
+mod energy_source;
+pub use energy_source::EnergySource;
+pub use energy_source::EnergyStorage;
+pub use energy_source::RefillLaw;
+pub use energy_source::SpeedDependantPower;

editoast/src/modelsv2/light_rolling_stock.rs

@@ -7,6 +7,7 @@ use diesel::QueryDsl;
 use diesel::SelectableHelper;
 use diesel_async::RunQueryDsl;
 use editoast_derive::ModelV2;
+use editoast_schemas::rolling_stock::EnergySource;
 use editoast_schemas::rolling_stock::Gamma;
 use editoast_schemas::rolling_stock::RollingResistance;
 use serde::Serialize;
@@ -20,7 +21,6 @@ use crate::modelsv2::Model;
 use crate::schema::rolling_stock::light_rolling_stock::LightEffortCurves;
 use crate::schema::rolling_stock::light_rolling_stock::LightRollingStock;
 use crate::schema::rolling_stock::light_rolling_stock::LightRollingStockWithLiveriesModel;
-use crate::schema::rolling_stock::EnergySource;
 use crate::schema::rolling_stock::RollingStockMetadata;
 use crate::schema::track_section::LoadingGaugeType;
 use crate::views::pagination::Paginate;

editoast/src/modelsv2/rolling_stock_model.rs

@@ -8,6 +8,7 @@ use diesel::SelectableHelper;
 use diesel_async::RunQueryDsl;
 use editoast_derive::ModelV2;
 use editoast_schemas::rolling_stock::EffortCurves;
+use editoast_schemas::rolling_stock::EnergySource;
 use editoast_schemas::rolling_stock::Gamma;
 use editoast_schemas::rolling_stock::RollingResistance;
 use serde::Deserialize;
@@ -20,7 +21,6 @@ use validator::ValidationErrors;
 use crate::error::Result;
 use crate::modelsv2::prelude::*;
 use crate::modelsv2::rolling_stock_livery::RollingStockLiveryMetadataModel;
-use crate::schema::rolling_stock::EnergySource;
 use crate::schema::rolling_stock::RollingStock;
 use crate::schema::rolling_stock::RollingStockMetadata;
 use crate::schema::rolling_stock::RollingStockWithLiveries;

editoast/src/schema/rolling_stock/mod.rs

@@ -8,10 +8,14 @@ use editoast_schemas::rolling_stock::ConditionalEffortCurve;
 use editoast_schemas::rolling_stock::EffortCurve;
 use editoast_schemas::rolling_stock::EffortCurveConditions;
 use editoast_schemas::rolling_stock::EffortCurves;
+use editoast_schemas::rolling_stock::EnergySource;
+use editoast_schemas::rolling_stock::EnergyStorage;
 use editoast_schemas::rolling_stock::Gamma;
 use editoast_schemas::rolling_stock::ModeEffortCurves;
+use editoast_schemas::rolling_stock::RefillLaw;
 use editoast_schemas::rolling_stock::RollingResistance;
 use editoast_schemas::rolling_stock::RollingStockComfortType;
+use editoast_schemas::rolling_stock::SpeedDependantPower;
 use serde::Deserialize;
 use serde::Serialize;
 use utoipa::ToSchema;
@@ -108,66 +112,3 @@ pub struct RollingStockMetadata {
     number: String,
     reference: String,
 }
-
-// Energy sources schema
-
-/// physical law defining how the storage can be refilled
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
-#[serde(deny_unknown_fields)]
-pub struct RefillLaw {
-    #[schema(minimum = 0)]
-    tau: f64,
-    #[schema(minimum = 0, maximum = 1)]
-    soc_ref: f64,
-}
-
-/// energy storage of an energy source (of a rolling stock, can be a electrical battery or a hydrogen/fuel powerPack)
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
-#[serde(deny_unknown_fields)]
-pub struct EnergyStorage {
-    capacity: f64,
-    #[schema(minimum = 0, maximum = 1)]
-    soc: f64,
-    #[schema(minimum = 0, maximum = 1)]
-    soc_min: f64,
-    #[schema(minimum = 0, maximum = 1)]
-    soc_max: f64,
-    #[schema(required)]
-    refill_law: Option<RefillLaw>,
-}
-
-/// power-speed curve (in an energy source)
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
-#[serde(deny_unknown_fields)]
-pub struct SpeedDependantPower {
-    speeds: Vec<f64>,
-    powers: Vec<f64>,
-}
-
-/// energy source of a rolling stock
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize, ToSchema)]
-#[serde(tag = "energy_source_type", deny_unknown_fields)]
-pub enum EnergySource {
-    /// energy source for a rolling stock representing a electrification
-    Electrification {
-        max_input_power: SpeedDependantPower,
-        max_output_power: SpeedDependantPower,
-        #[schema(minimum = 0, maximum = 1)]
-        efficiency: f64,
-    },
-    PowerPack {
-        max_input_power: SpeedDependantPower,
-        max_output_power: SpeedDependantPower,
-        energy_storage: EnergyStorage,
-        #[schema(minimum = 0, maximum = 1)]
-        efficiency: f64,
-    },
-    /// energy source for a rolling stock representing a battery
-    Battery {
-        max_input_power: SpeedDependantPower,
-        max_output_power: SpeedDependantPower,
-        energy_storage: EnergyStorage,
-        #[schema(minimum = 0, maximum = 1)]
-        efficiency: f64,
-    },
-}