front: add option usingspeedlimits to validconfig

Signed-off-by: Alex Rolland <[email protected]> Signed-off-by: Clara Ni <[email protected]>
OpenRailAssociation · Feb 24, 2025 · f310a47 · f310a47
1 parent 85702d1
commit f310a47
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 2 deletions.
diff --git a/front/src/applications/operationalStudies/views/ManageTrainSchedule.tsx b/front/src/applications/operationalStudies/views/ManageTrainSchedule.tsx
@@ -1,4 +1,4 @@
-import { useCallback, useMemo } from 'react';
+import { useCallback, useEffect, useMemo } from 'react';
 
 import { compact } from 'lodash';
 import { useTranslation } from 'react-i18next';
@@ -27,7 +27,10 @@ import {
 } from 'modules/trainschedule/components/ManageTrainSchedule/ManageTrainScheduleMap/ItineraryMarkers';
 import SimulationSettings from 'modules/trainschedule/components/ManageTrainSchedule/SimulationSettings';
 import TrainSettings from 'modules/trainschedule/components/ManageTrainSchedule/TrainSettings';
-import { updateRollingStockComfort } from 'reducers/osrdconf/operationalStudiesConf';
+import {
+  resetUsingSpeedLimits,
+  updateRollingStockComfort,
+} from 'reducers/osrdconf/operationalStudiesConf';
 import {
   getConstraintDistribution,
   getDestination,
@@ -198,6 +201,15 @@ const ManageTrainSchedule = () => {
     ),
   };
 
+  // reset usingSpeedLimits when unmounting, to prevent user from being able to create a train
+  // without speed limits
+  useEffect(
+    () => () => {
+      dispatch(resetUsingSpeedLimits());
+    },
+    []
+  );
+
   return (
     <>
       <div className="osrd-config-item-container mb-3">

diff --git a/front/src/modules/trainschedule/components/ManageTrainSchedule/helpers/checkCurrentConfig.ts b/front/src/modules/trainschedule/components/ManageTrainSchedule/helpers/checkCurrentConfig.ts
@@ -31,6 +31,7 @@ const checkCurrentConfig = (
     speedLimitByTag,
     initialSpeed,
     usingElectricalProfiles,
+    usingSpeedLimits,
     rollingStockComfort,
     powerRestriction,
     startTime,
@@ -145,6 +146,7 @@ const checkCurrentConfig = (
     rollingStockComfort,
     initialSpeed: initialSpeed ? kmhToMs(initialSpeed) : 0,
     usingElectricalProfiles,
+    usingSpeedLimits,
     path: compact(pathSteps).map((step) => ({ id: step.id, ...getStepLocation(step) })),
     margins: formatMargin(compact(pathSteps)),
     schedule: formatSchedule(compact(pathSteps)),

diff --git a/...odules/trainschedule/components/ManageTrainSchedule/helpers/formatTrainSchedulePayload.ts b/...odules/trainschedule/components/ManageTrainSchedule/helpers/formatTrainSchedulePayload.ts
@@ -16,6 +16,7 @@ export default function formatTrainSchedulePayload(
     speedLimitByTag,
     initialSpeed,
     usingElectricalProfiles,
+    usingSpeedLimits,
     rollingStockComfort,
     margins,
     powerRestrictions,
@@ -29,6 +30,7 @@ export default function formatTrainSchedulePayload(
     margins,
     options: {
       use_electrical_profiles: usingElectricalProfiles,
+      use_speed_limits_for_simulation: usingSpeedLimits,
     },
     path,
     power_restrictions: powerRestrictions,

diff --git a/front/src/modules/trainschedule/components/ManageTrainSchedule/types.ts b/front/src/modules/trainschedule/components/ManageTrainSchedule/types.ts
@@ -57,6 +57,7 @@ export type ValidConfig = {
   rollingStockComfort: TrainScheduleBase['comfort'];
   initialSpeed: number;
   usingElectricalProfiles: boolean;
+  usingSpeedLimits: boolean;
   path: TrainScheduleBase['path'];
   margins: TrainScheduleBase['margins'];
   schedule: TrainScheduleBase['schedule'];

diff --git a/front/src/reducers/index.ts b/front/src/reducers/index.ts
@@ -91,6 +91,7 @@ const buildOsrdConfPersistConfig = <T extends OperationalStudiesConfState | Osrd
   key: slice.name,
   storage,
   transforms: [operationalStudiesDateTransform, pathStepsTransform],
+  blacklist: ['usingSpeedLimits'],
 });
 
 export const persistConfig = {

diff --git a/front/src/reducers/osrdconf/operationalStudiesConf/index.ts b/front/src/reducers/osrdconf/operationalStudiesConf/index.ts
@@ -23,6 +23,7 @@ export type OperationalStudiesConfState = OsrdConfState & {
   pathSteps: (PathStep | null)[];
   constraintDistribution: Distribution;
   usingElectricalProfiles: boolean;
+  usingSpeedLimits: boolean;
   powerRestriction: PowerRestriction[];
   trainCount: number;
   trainStep: number;
@@ -40,6 +41,7 @@ export const operationalStudiesInitialConf: OperationalStudiesConfState = {
   pathSteps: [null, null],
   constraintDistribution: 'MARECO',
   usingElectricalProfiles: true,
+  usingSpeedLimits: true,
   powerRestriction: [],
   trainCount: 1,
   trainDelta: 15,
@@ -79,6 +81,7 @@ export const operationalStudiesConfSlice = createSlice({
       state.initialSpeed = initial_speed ? Math.floor(msToKmh(initial_speed) * 10) / 10 : 0;
 
       state.usingElectricalProfiles = options?.use_electrical_profiles ?? true;
+      state.usingSpeedLimits = options?.use_speed_limits_for_simulation ?? true;
       state.labels = labels;
       state.speedLimitByTag = speedLimitTag || undefined;
       state.powerRestriction = power_restrictions || [];
@@ -100,13 +103,17 @@ export const operationalStudiesConfSlice = createSlice({
         upsertPathStep(state.pathSteps, suggestedOp);
       });
     },
+    resetUsingSpeedLimits(state: Draft<OperationalStudiesConfState>) {
+      state.usingSpeedLimits = true;
+    },
   },
 });
 
 export const operationalStudiesConfSliceActions = operationalStudiesConfSlice.actions;
 
 export const {
   selectTrainToEdit,
+  resetUsingSpeedLimits,
 
   // train settings reducer
   updateName,