core/api add STDCM grid margins

Author: clarani

api/openapi.yaml

@@ -1046,6 +1046,18 @@ components:
         speed_limit_composition:
           type: string
           description: Train category for speed limits
+        margin_before:
+          type: number
+          format: double
+          description: |
+            Margin of x seconds before the train passage, which means that the path used by the train should
+            be free and available at least x seconds before its passage.
+        margin_after:
+          type: number
+          format: double
+          description: |
+            Margin of y seconds after the train passage, which means that the path used by the train should
+            be free and available at least y seconds after its passage.
     Path:
       properties:
         id:

api/osrd_infra/serializers.py

@@ -173,3 +173,5 @@ class WaypointInputSerializer(Serializer):
     maximum_departure_delay = serializers.FloatField(required=False, allow_null=True)
     maximum_relative_run_time = serializers.FloatField(required=False, allow_null=True)
     speed_limit_composition = serializers.CharField(max_length=255, required=False, allow_null=True)
+    margin_before = serializers.FloatField(required=False, allow_null=True)
+    margin_after = serializers.FloatField(required=False, allow_null=True)

api/osrd_infra/views/stdcm.py

@@ -90,6 +90,8 @@ def make_stdcm_core_payload(request):
         "maximum_departure_delay",
         "maximum_relative_run_time",
         "speed_limit_composition",
+        "margin_before",
+        "margin_after"
         # Don't forget to add these fields to the serializer
     ]
     for parameter in optional_forwarded_parameters:

core/openapi.yaml

@@ -557,6 +557,18 @@ components:
         speed_limit_composition:
           type: string
           description: Train composition used for speed limit
+        margin_before:
+          type: number
+          format: double
+          description: |
+            Margin of x seconds before the train passage, which means that the path used by the train should
+            be free and available at least x seconds before its passage.
+        margin_after:
+          type: number
+          format: double
+          description: |
+            Margin of y seconds after the train passage, which means that the path used by the train should
+            be free and available at least y seconds after its passage.
     SimulationRequest:
       required:
         - infra

core/src/main/java/fr/sncf/osrd/api/stdcm/STDCMEndpoint.java

@@ -92,7 +92,9 @@ public Response act(Request req) throws InvalidRollingStock, InvalidSchedule {
             var unavailableSpace = UnavailableSpaceBuilder.computeUnavailableSpace(
                     infra,
                     occupancies,
-                    rollingStock
+                    rollingStock,
+                    request.marginBefore,
+                    request.marginAfter
             );
             double minRunTime = getMinRunTime(
                     infra, rollingStock, comfort, startLocations, endLocations, request.timeStep);

core/src/main/java/fr/sncf/osrd/api/stdcm/STDCMRequest.java

@@ -101,6 +101,22 @@ public final class STDCMRequest {
     @Json(name = "speed_limit_composition")
     public String speedLimitComposition = null;
 
+    /**
+     * Margin of x seconds before the train passage,
+     * which means that the path used by the train should be free and available
+     * at least x seconds before its passage.
+     */
+    @Json(name = "margin_before")
+    public double marginBefore = 0;
+
+    /**
+     * Margin of y seconds after the train passage,
+     * which means that the path used by the train should be free and available
+     * at least y seconds after its passage.
+     */
+    @Json(name = "margin_after")
+    public double marginAfter = 0;
+
     /**
      * Create a default STDCMRequest
      */
@@ -114,7 +130,9 @@ public STDCMRequest() {
                 null,
                 Double.NaN,
                 Double.NaN,
-                null
+                null,
+                Double.NaN,
+                Double.NaN
         );
     }
 
@@ -130,7 +148,9 @@ public STDCMRequest(
             Collection<PathfindingWaypoint> endPoints,
             double startTime,
             double endTime,
-            String speedLimitComposition
+            String speedLimitComposition,
+            double marginBefore,
+            double marginAfter
     ) {
         this.infra = infra;
         this.expectedVersion = expectedVersion;
@@ -141,6 +161,8 @@ public STDCMRequest(
         this.startTime = startTime;
         this.endTime = endTime;
         this.speedLimitComposition = speedLimitComposition;
+        this.marginBefore = marginBefore;
+        this.marginAfter = marginAfter;
     }
 
     public static class RouteOccupancy {

core/src/main/java/fr/sncf/osrd/api/stdcm/UnavailableSpaceBuilder.java

@@ -23,7 +23,9 @@ public class UnavailableSpaceBuilder {
     public static Multimap<SignalingRoute, OccupancyBlock> computeUnavailableSpace(
             SignalingInfra infra,
             Collection<STDCMRequest.RouteOccupancy> occupancies,
-            RollingStock rollingStock
+            RollingStock rollingStock,
+            double marginBefore,
+            double marginAfter
     ) {
 
         Multimap<SignalingRoute, OccupancyBlock> res = HashMultimap.create();
@@ -35,8 +37,8 @@ public static Multimap<SignalingRoute, OccupancyBlock> computeUnavailableSpace(
             var startRouteNode = routeGraph.incidentNodes(currentRoute).nodeU();
             var endRouteNode = routeGraph.incidentNodes(currentRoute).nodeV();
             var length = currentRoute.getInfraRoute().getLength();
-            var timeStart = occupancy.startOccupancyTime;
-            var timeEnd = occupancy.endOccupancyTime;
+            var timeStart = occupancy.startOccupancyTime - marginBefore;
+            var timeEnd = occupancy.endOccupancyTime + marginAfter;
 
             //Generating current block occupancy
             var block = new OccupancyBlock(timeStart, timeEnd, 0, length);

core/src/test/java/fr/sncf/osrd/api/STDCMEndpointTest.java

@@ -36,7 +36,9 @@ public void simpleEmptyTimetable() throws Exception {
                 )),
                 0,
                 0,
-                "foo"
+                "foo",
+                0,
+                0
         ));
 
         var result = readBodyResponse(

core/src/test/java/fr/sncf/osrd/stdcm/STDCMHelpers.java

@@ -54,7 +54,9 @@ public static Multimap<SignalingRoute, OccupancyBlock> makeOccupancyFromPath(
         return UnavailableSpaceBuilder.computeUnavailableSpace(
                 infra,
                 occupancies,
-                REALISTIC_FAST_TRAIN
+                REALISTIC_FAST_TRAIN,
+                0,
+                0
         );
     }
 

core/src/test/java/fr/sncf/osrd/stdcm/UnavailableSpaceBuilderTests.java

@@ -16,7 +16,7 @@ public class UnavailableSpaceBuilderTests {
     @Test
     public void testNoOccupancy() throws Exception {
         var infra = Helpers.infraFromRJS(Helpers.getExampleInfra("tiny_infra/infra.json"));
-        var res = computeUnavailableSpace(infra, Set.of(), REALISTIC_FAST_TRAIN);
+        var res = computeUnavailableSpace(infra, Set.of(), REALISTIC_FAST_TRAIN, 0, 0);
         assertTrue(res.isEmpty());
     }
 
@@ -29,7 +29,9 @@ public void testFirstRouteOccupied() {
         var res = computeUnavailableSpace(
                 infra,
                 Set.of(new STDCMRequest.RouteOccupancy("a->b", 0, 100)),
-                REALISTIC_FAST_TRAIN
+                REALISTIC_FAST_TRAIN,
+                0,
+                0
         );
         assertEquals(
                 Set.of(
@@ -59,7 +61,9 @@ public void testSecondRouteOccupied() {
         var res = computeUnavailableSpace(
                 infra,
                 Set.of(new STDCMRequest.RouteOccupancy("b->c", 0, 100)),
-                REALISTIC_FAST_TRAIN
+                REALISTIC_FAST_TRAIN,
+                0,
+                0
         );
         assertEquals(
                 Set.of(
@@ -96,7 +100,9 @@ public void testBranchingRoutes() {
         final var res = computeUnavailableSpace(
                 infra,
                 Set.of(new STDCMRequest.RouteOccupancy("a1->center", 0, 100)),
-                REALISTIC_FAST_TRAIN
+                REALISTIC_FAST_TRAIN,
+                0,
+                0
         );
         assertEquals(
                 Set.of(
@@ -132,7 +138,9 @@ public void testThirdRoute() {
         var res = computeUnavailableSpace(
                 infra,
                 Set.of(new STDCMRequest.RouteOccupancy("a->b", 0, 100)),
-                REALISTIC_FAST_TRAIN
+                REALISTIC_FAST_TRAIN,
+                0,
+                0
         );
         assertEquals(
                 Set.of(

tests/fuzzer/fuzzer.py

@@ -167,6 +167,8 @@ def make_stdcm_payload(base_url: str, infra_id: int, path: List[Tuple[str, float
             "track_section": last_edge,
             "offset": last_offset,
         }],
+        "margin_before": 0,
+        "margin_after": 0,
     }
 
 

tests/tests/stdcm/between_trains.py

@@ -26,7 +26,9 @@ def run(*args, **kwargs):
         "start_time": 5000,
         "name": "foo",
         "start_points": [start],
-        "end_points": [stop]
+        "end_points": [stop],
+        "margin_before": 0,
+        "margin_after": 0
     }
     r = requests.post(base_url + f"stdcm/", json=payload)
     delete_timetable(base_url, timetable)

tests/tests/stdcm/empty_timetable.py

@@ -20,7 +20,9 @@ def run(*args, **kwargs):
         "end_points": [{
             "track_section": "TE0",
             "offset": 0
-        }]
+        }],
+        "margin_before": 0,
+        "margin_after": 0
     }
     r = requests.post(base_url + f"stdcm/", json=payload)
     delete_timetable(base_url, timetable)