editoast: add field for supported signaling systems in rs model

tests: rolling stock

Author: SarahBellaha

core/osrd-railjson/src/main/java/fr/sncf/osrd/railjson/schema/rollingstock/RJSRollingStock.java

@@ -94,6 +94,9 @@ public class RJSRollingStock implements Identified {
     @Json(name = "raise_pantograph_time")
     public Double raisePantographTime = null;
 
+    @Json(name = "supported_signaling_systems")
+    public String[] supportedSignalingSystems = null;
+    
     public enum GammaType {
         CONST,
         MAX

core/src/main/java/fr/sncf/osrd/railjson/parser/RJSRollingStockParser.java

@@ -123,7 +123,8 @@ else if (!rjsRollingStock.railjsonVersion.equals(RJSRollingStock.CURRENT_VERSION
                 rjsRollingStock.basePowerClass,
                 rjsRollingStock.powerRestrictions,
                 rjsRollingStock.electricalPowerStartUpTime,
-                rjsRollingStock.raisePantographTime
+                rjsRollingStock.raisePantographTime,
+                rjsRollingStock.supportedSignalingSystems
         );
     }
 

core/src/main/java/fr/sncf/osrd/train/RollingStock.java

@@ -101,6 +101,8 @@ public final class RollingStock implements PhysicsRollingStock {
     public final Double electricalPowerStartUpTime;
     public final Double raisePantographTime;
 
+    public final String[] supportedSignalingSystems;
+
     @Override
     public double getMass() {
         return mass;
@@ -331,11 +333,12 @@ public RollingStock(
             RJSLoadingGaugeType loadingGaugeType,
             Map<String, ModeEffortCurves> modes,
             String defaultMode,
-            String basePowerclass
+            String basePowerclass,
+            String[] supportedSignalingSystems
     ) {
         this(id, length, mass, inertiaCoefficient, a, b, c, maxSpeed, startUpTime, startUpAcceleration,
                 comfortAcceleration, gamma, gammaType, loadingGaugeType, modes, defaultMode, basePowerclass, Map.of(),
-                0., 0.);
+                0., 0., supportedSignalingSystems);
     }
 
     /**
@@ -361,7 +364,8 @@ public RollingStock(
             String basePowerclass,
             Map<String, String> powerRestrictions,
             Double electricalPowerStartUpTime,
-            Double raisePantographTime
+            Double raisePantographTime,
+            String[] supportedSignalingSystems
     ) {
         this.id = id;
         this.A = a;
@@ -384,6 +388,7 @@ public RollingStock(
         this.powerRestrictions = powerRestrictions;
         this.electricalPowerStartUpTime = electricalPowerStartUpTime;
         this.raisePantographTime = raisePantographTime;
+        this.supportedSignalingSystems = supportedSignalingSystems;
 
         assert !isElectric() || (this.electricalPowerStartUpTime != null && this.raisePantographTime != null) :
                 "Electrical power start up time and Raise pantograph time must be defined for an electric train";

core/src/test/java/fr/sncf/osrd/train/TestTrains.java

@@ -7,7 +7,9 @@
 import com.google.common.collect.Lists;
 import fr.sncf.osrd.utils.Helpers;
 import fr.sncf.osrd.envelope_sim.PhysicsRollingStock;
+import fr.sncf.osrd.envelope_sim.SimpleRollingStock.CurveShape;
 import fr.sncf.osrd.railjson.schema.rollingstock.RJSLoadingGaugeType;
+import fr.sncf.osrd.train.RollingStock.Comfort;
 import org.junit.jupiter.api.Test;
 import java.util.*;
 
@@ -107,7 +109,8 @@ private static Map<String, RollingStock.ModeEffortCurves> createModeEffortCurves
                 RJSLoadingGaugeType.G1,
                 linearModeEffortCurves,
                 "thermal",
-                "1"
+                "1",
+                new String[]{"BAL", "BAPR", "TVM300", "TVM430"}
         );
 
         VERY_LONG_FAST_TRAIN = new RollingStock(
@@ -124,7 +127,8 @@ private static Map<String, RollingStock.ModeEffortCurves> createModeEffortCurves
                 RJSLoadingGaugeType.G1,
                 linearModeEffortCurves,
                 "thermal",
-                "1"
+                "1",
+                new String[]{"BAL", "BAPR", "TVM300", "TVM430"}
         );
 
         REALISTIC_FAST_TRAIN = new RollingStock(
@@ -144,7 +148,8 @@ private static Map<String, RollingStock.ModeEffortCurves> createModeEffortCurves
                 "5",
                 Map.of("Restrict1", "4", "Restrict2", "3"),
                 0.,
-                0.
+                0.,
+                new String[]{"BAL", "BAPR", "TVM300", "TVM430"}
         );
 
         REALISTIC_FAST_TRAIN_MAX_DEC_TYPE = new RollingStock(
@@ -161,7 +166,8 @@ private static Map<String, RollingStock.ModeEffortCurves> createModeEffortCurves
                 RJSLoadingGaugeType.G1,
                 linearModeEffortCurves,
                 "thermal",
-                "1"
+                "1",
+                new String[]{"BAL", "BAPR", "TVM300", "TVM430"}
         );
 
         FAST_TRAIN_LARGE_GAUGE = new RollingStock(
@@ -178,7 +184,8 @@ private static Map<String, RollingStock.ModeEffortCurves> createModeEffortCurves
                 RJSLoadingGaugeType.GC,
                 linearModeEffortCurves,
                 "thermal",
-                "1"
+                "1",
+                new String[]{"BAL", "BAPR", "TVM300", "TVM430"}
         );
 
         FAST_ELECTRIC_TRAIN = new RollingStock(
@@ -196,7 +203,8 @@ private static Map<String, RollingStock.ModeEffortCurves> createModeEffortCurves
                 createModeEffortCurves(MAX_SPEED, CurveShape.LINEAR,
                         Map.of("25000V", new RollingStock.EffortCurveConditions[0])),
                 "25000V",
-                "1"
+                "1",
+                new String[]{"BAL", "BAPR", "TVM300", "TVM430"}
         );
 
         CONSTANT_POWER_TRAIN = new RollingStock(
@@ -214,7 +222,8 @@ private static Map<String, RollingStock.ModeEffortCurves> createModeEffortCurves
                 createModeEffortCurves(MAX_SPEED, CurveShape.HYPERBOLIC,
                         Map.of("thermal", new RollingStock.EffortCurveConditions[0])),
                 "thermal",
-                "1"
+                "1",
+                new String[]{"BAL", "BAPR", "TVM300", "TVM430"}
         );
     }
 

editoast/migrations/2024-02-01-130425_add-rolling-stock-field-supported-signaling-systems/down.sql

@@ -0,0 +1,2 @@
+ALTER TABLE rolling_stock
+DROP COLUMN supported_signaling_systems;

editoast/migrations/2024-02-01-130425_add-rolling-stock-field-supported-signaling-systems/up.sql

@@ -0,0 +1,2 @@
+ALTER TABLE rolling_stock
+ADD supported_signaling_systems jsonb NOT NULL DEFAULT ('["BAPR", "BAL", "TVM300", "TVM430"]');

editoast/openapi.yaml

@@ -884,6 +884,10 @@ components:
         startup_time:
           format: double
           type: number
+        supported_signaling_systems:
+          items:
+            $ref: '#/components/schemas/SignalingSystem'
+          type: array
       required:
       - id
       - name
@@ -904,6 +908,7 @@ components:
       - metadata
       - power_restrictions
       - energy_sources
+      - supported_signaling_systems
       type: object
     LightRollingStockWithLiveries:
       allOf:
@@ -1961,6 +1966,10 @@ components:
         startup_time:
           format: double
           type: number
+        supported_signaling_systems:
+          items:
+            $ref: '#/components/schemas/SignalingSystem'
+          type: array
       required:
       - name
       - effort_curves
@@ -2712,6 +2721,13 @@ components:
       - aspect_label
       - track
       type: object
+    SignalingSystem:
+      enum:
+      - BAL
+      - BAPR
+      - TVM300
+      - TVM430
+      type: string
     SimulationPowerRestrictionRange:
       properties:
         code:

editoast/src/models/rolling_stock/light_rolling_stock.rs

@@ -3,7 +3,9 @@ use crate::models::rolling_stock::rolling_stock_livery::RollingStockLiveryMetada
 use crate::schema::rolling_stock::light_rolling_stock::{
     LightEffortCurves, LightRollingStock, LightRollingStockWithLiveries,
 };
-use crate::schema::rolling_stock::{EnergySource, Gamma, RollingResistance, RollingStockMetadata};
+use crate::schema::rolling_stock::{
+    EnergySource, Gamma, RollingResistance, RollingStockMetadata, SignalingSystem,
+};
 use crate::tables::rolling_stock;
 use crate::views::pagination::{Paginate, PaginatedResponse};
 use crate::DbPool;
@@ -51,6 +53,8 @@ pub struct LightRollingStockModel {
     electrical_power_startup_time: Option<f64>,
     raise_pantograph_time: Option<f64>,
     pub version: i64,
+    #[schema(value_type = Vec<SignalingSystem>)]
+    supported_signaling_systems: DieselJson<Vec<SignalingSystem>>,
 }
 
 impl LightRollingStockModel {
@@ -118,6 +122,7 @@ impl From<LightRollingStockModel> for LightRollingStock {
             power_restrictions: rolling_stock_model.power_restrictions,
             energy_sources: rolling_stock_model.energy_sources,
             version: rolling_stock_model.version,
+            supported_signaling_systems: rolling_stock_model.supported_signaling_systems,
         }
     }
 }

editoast/src/models/rolling_stock/mod.rs

@@ -13,7 +13,7 @@ use crate::models::rolling_stock::rolling_stock_livery::RollingStockLiveryMetada
 use crate::models::{Create, Identifiable, TextArray, Update};
 use crate::schema::rolling_stock::{
     EffortCurves, EnergySource, Gamma, RollingResistance, RollingStock, RollingStockCommon,
-    RollingStockMetadata, RollingStockWithLiveries,
+    RollingStockMetadata, RollingStockWithLiveries, SignalingSystem,
 };
 use crate::schema::track_section::LoadingGaugeType;
 use crate::tables::rolling_stock;
@@ -130,6 +130,9 @@ pub struct RollingStockModel {
     #[diesel(deserialize_as = i64)]
     #[schema(value_type = i64)]
     pub version: Option<i64>,
+    #[diesel(deserialize_as = DieselJson<Vec<SignalingSystem>>)]
+    #[schema(value_type = Vec<SignalingSystem>)]
+    pub supported_signaling_systems: Option<DieselJson<Vec<SignalingSystem>>>,
 }
 
 fn validate_rolling_stock(
@@ -295,6 +298,7 @@ impl From<RollingStockModel> for RollingStockCommon {
                 .electrical_power_startup_time
                 .unwrap(),
             raise_pantograph_time: rolling_stock_model.raise_pantograph_time.unwrap(),
+            supported_signaling_systems: rolling_stock_model.supported_signaling_systems.unwrap().0,
         }
     }
 }

editoast/src/schema/rolling_stock/light_rolling_stock.rs

@@ -6,7 +6,7 @@ use utoipa::ToSchema;
 
 use crate::models::rolling_stock::rolling_stock_livery::RollingStockLiveryMetadata;
 
-use super::{EnergySource, Gamma, RollingResistance, RollingStockMetadata};
+use super::{EnergySource, Gamma, RollingResistance, RollingStockMetadata, SignalingSystem};
 
 crate::schemas! {
     LightRollingStock,
@@ -67,6 +67,9 @@ pub struct LightRollingStock {
     #[serde(skip)]
     #[diesel(sql_type = BigInt)]
     pub version: i64,
+    #[diesel(sql_type = Jsonb)]
+    #[schema(value_type = Vec<SignalingSystem>)]
+    pub supported_signaling_systems: DieselJson<Vec<SignalingSystem>>,
 }
 
 #[derive(Debug, QueryableByName, Serialize, Deserialize, ToSchema)]

editoast/src/schema/rolling_stock/mod.rs

@@ -7,9 +7,10 @@ use std::collections::HashMap;
 use strum_macros::{Display, EnumString};
 use utoipa::ToSchema;
 
-use crate::models::rolling_stock::rolling_stock_livery::RollingStockLiveryMetadata;
-use rolling_stock_livery::RollingStockLivery;
-
+use crate::{
+    models::rolling_stock::rolling_stock_livery::RollingStockLiveryMetadata,
+    schema::rolling_stock::rolling_stock_livery::RollingStockLivery,
+};
 crate::schemas! {
     RollingStockComfortType,
     RollingStockCommon,
@@ -28,6 +29,7 @@ crate::schemas! {
     EnergyStorage,
     RefillLaw,
     RollingStockLivery,
+    SignalingSystem,
     light_rolling_stock::schemas(),
 }
 
@@ -62,6 +64,8 @@ pub struct RollingStockCommon {
     /// The time it takes to raise this train's pantograph in seconds. Is null if the train is not electric.
     #[schema(example = 15.0)]
     pub raise_pantograph_time: Option<f64>,
+    #[serde(default)]
+    pub supported_signaling_systems: Vec<SignalingSystem>,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, ToSchema)]
@@ -261,6 +265,17 @@ pub enum EnergySource {
     },
 }
 
+#[derive(Clone, Debug, PartialEq, EnumString, Deserialize, Serialize, ToSchema)]
+#[strum(serialize_all = "UPPERCASE")]
+#[serde(rename_all = "UPPERCASE")]
+#[serde(deny_unknown_fields)]
+pub enum SignalingSystem {
+    Bal,
+    Bapr,
+    Tvm300,
+    Tvm430,
+}
+
 #[cfg(test)]
 mod tests {
     use crate::schema::rolling_stock::EffortCurve;

editoast/src/tables.rs

@@ -423,6 +423,7 @@ diesel::table! {
         electrical_power_startup_time -> Nullable<Float8>,
         raise_pantograph_time -> Nullable<Float8>,
         version -> Int8,
+        supported_signaling_systems -> Jsonb,
     }
 }
 

editoast/src/tests/example_rolling_stock_1.json

@@ -983,5 +983,6 @@
     "energy_sources": [],
     "power_restrictions": {"C2":"2", "C5":"5"},
     "electrical_power_startup_time": 5.0,
-    "raise_pantograph_time": 15.0
+    "raise_pantograph_time": 15.0,
+    "supported_signaling_systems": ["BAL", "BAPR", "TVM300", "TVM430"]
 }

editoast/src/tests/example_rolling_stock_2_energy_sources.json

@@ -210,5 +210,6 @@
     ],
     "power_restrictions": {},
     "electrical_power_startup_time": 6.0,
-    "raise_pantograph_time": 16.0
+    "raise_pantograph_time": 16.0,
+    "supported_signaling_systems": ["BAL", "BAPR", "TVM300", "TVM430"]
 }

editoast/src/tests/example_rolling_stock_3.json

@@ -68,5 +68,6 @@
     "energy_sources": [],
     "power_restrictions": {},
     "electrical_power_startup_time": 4.0,
-    "raise_pantograph_time": 14.0
+    "raise_pantograph_time": 14.0,
+    "supported_signaling_systems": ["BAL", "BAPR", "TVM300", "TVM430"]
 }

editoast/src/tests/small_infra/stdcm/test_1/stdcm_core_payload.json

@@ -121,7 +121,8 @@
     "power_restrictions": {},
     "energy_sources": [],
     "electrical_power_startup_time": null,
-    "raise_pantograph_time": null
+    "raise_pantograph_time": null,
+    "supported_signaling_systems": ["BAL", "BAPR", "TVM300", "TVM430"]
   },
   "comfort": "STANDARD",
   "route_occupancies": [],

editoast/src/views/rolling_stocks/mod.rs

@@ -145,6 +145,9 @@ impl From<RollingStockForm> for RollingStockModel {
             energy_sources: Some(DieselJson(rolling_stock.common.energy_sources)),
             electrical_power_startup_time: Some(rolling_stock.common.electrical_power_startup_time),
             raise_pantograph_time: Some(rolling_stock.common.raise_pantograph_time),
+            supported_signaling_systems: Some(DieselJson(
+                rolling_stock.common.supported_signaling_systems,
+            )),
             ..Default::default()
         }
     }

front/src/common/api/osrdEditoastApi.ts

@@ -1591,6 +1591,7 @@ export type RollingResistance = {
   C: number;
   type: string;
 };
+export type SignalingSystem = 'BAL' | 'BAPR' | 'TVM300' | 'TVM430';
 export type LightRollingStock = {
   base_power_class?: string | null;
   comfort_acceleration: number;
@@ -1614,6 +1615,7 @@ export type LightRollingStock = {
   rolling_resistance: RollingResistance;
   startup_acceleration: number;
   startup_time: number;
+  supported_signaling_systems: SignalingSystem[];
 };
 export type RollingStockLiveryMetadata = {
   compound_image_id?: number | null;
@@ -1902,6 +1904,7 @@ export type RollingStockCommon = {
   rolling_resistance: RollingResistance;
   startup_acceleration: number;
   startup_time: number;
+  supported_signaling_systems?: SignalingSystem[];
 };
 export type RollingStock = RollingStockCommon & {
   id: number;