Add the possibility to launch a state estimation on a network (#578)

* Add the possibility to launch a state estimation on a network

Signed-off-by: Franck LECUYER <[email protected]>
Co-authored-by: David BRAQUART <[email protected]>

Author: FranckLecuyer

src/main/java/org/gridsuite/study/server/RestResponseEntityExceptionHandler.java

@@ -43,7 +43,8 @@ protected ResponseEntity<Object> handleStudyException(StudyException exception)
                     VOLTAGE_INIT_PARAMETERS_NOT_FOUND,
                     SECURITY_ANALYSIS_PARAMETERS_NOT_FOUND,
                     LOADFLOW_PARAMETERS_NOT_FOUND,
-                    SENSITIVITY_ANALYSIS_PARAMETERS_NOT_FOUND
+                    SENSITIVITY_ANALYSIS_PARAMETERS_NOT_FOUND,
+                    STATE_ESTIMATION_NOT_FOUND
                     -> ResponseEntity.status(HttpStatus.NOT_FOUND).body(exception.getType());
             case CASE_NOT_FOUND -> ResponseEntity.status(HttpStatus.FAILED_DEPENDENCY).body(exception.getMessage());
             case STUDY_ALREADY_EXISTS -> ResponseEntity.status(HttpStatus.CONFLICT).body(type);
@@ -54,7 +55,8 @@ protected ResponseEntity<Object> handleStudyException(StudyException exception)
                     NON_EVACUATED_ENERGY_RUNNING,
                     DYNAMIC_SIMULATION_RUNNING,
                     SHORT_CIRCUIT_ANALYSIS_RUNNING,
-                    VOLTAGE_INIT_RUNNING
+                    VOLTAGE_INIT_RUNNING,
+                    STATE_ESTIMATION_RUNNING
                     -> ResponseEntity.status(HttpStatus.FORBIDDEN).body(type);
             case NOT_ALLOWED,
                     BAD_NODE_TYPE,

src/main/java/org/gridsuite/study/server/StudyConstants.java

@@ -34,6 +34,7 @@ private StudyConstants() {
     public static final String TIME_SERIES_API_VERSION = "v1";
     public static final String DYNAMIC_MAPPING_API_VERSION = ""; // mapping server is now without version, must be v1 in the next time
     public static final String FILTER_API_VERSION = "v1";
+    public static final String STATE_ESTIMATION_API_VERSION = "v1";
 
     public static final String NETWORK_UUID = "networkUuid";
     public static final String CASE_UUID = "caseUuid";

src/main/java/org/gridsuite/study/server/StudyController.java

@@ -77,6 +77,7 @@ public class StudyController {
     private final LoadFlowService loadflowService;
     private final CaseService caseService;
     private final RemoteServicesInspector remoteServicesInspector;
+    private final StateEstimationService stateEstimationService;
 
     public StudyController(StudyService studyService,
             NetworkService networkStoreService,
@@ -90,7 +91,8 @@ public StudyController(StudyService studyService,
             VoltageInitService voltageInitService,
             LoadFlowService loadflowService,
             CaseService caseService,
-            RemoteServicesInspector remoteServicesInspector) {
+            RemoteServicesInspector remoteServicesInspector,
+            StateEstimationService stateEstimationService) {
         this.studyService = studyService;
         this.networkModificationTreeService = networkModificationTreeService;
         this.networkStoreService = networkStoreService;
@@ -104,6 +106,7 @@ public StudyController(StudyService studyService,
         this.loadflowService = loadflowService;
         this.caseService = caseService;
         this.remoteServicesInspector = remoteServicesInspector;
+        this.stateEstimationService = stateEstimationService;
     }
 
     @InitBinder
@@ -1905,4 +1908,47 @@ public ResponseEntity<String> exportFilter(
             @Parameter(description = "Filter uuid to be applied") @PathVariable("filterUuid") UUID filterUuid) {
         return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(studyService.exportFilter(studyUuid, filterUuid));
     }
+
+    @PostMapping(value = "/studies/{studyUuid}/nodes/{nodeUuid}/state-estimation/run")
+    @Operation(summary = "run state estimation on study")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The state estimation has started")})
+    public ResponseEntity<Void> runStateEstimation(@Parameter(description = "studyUuid") @PathVariable("studyUuid") UUID studyUuid,
+                                                    @Parameter(description = "nodeUuid") @PathVariable("nodeUuid") UUID nodeUuid,
+                                                    @RequestHeader(HEADER_USER_ID) String userId) {
+        studyService.assertIsNodeNotReadOnly(nodeUuid);
+        studyService.runStateEstimation(studyUuid, nodeUuid, userId);
+        return ResponseEntity.ok().build();
+    }
+
+    @GetMapping(value = "/studies/{studyUuid}/nodes/{nodeUuid}/state-estimation/result")
+    @Operation(summary = "Get a state estimation result on study")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The state estimation result"),
+        @ApiResponse(responseCode = "204", description = "No state estimation has been done yet"),
+        @ApiResponse(responseCode = "404", description = "The state estimation has not been found")})
+    public ResponseEntity<String> getStateEstimationResult(@Parameter(description = "study UUID") @PathVariable("studyUuid") UUID studyUuid,
+                                                            @Parameter(description = "nodeUuid") @PathVariable("nodeUuid") UUID nodeUuid) {
+        String result = stateEstimationService.getStateEstimationResult(nodeUuid);
+        return result != null ? ResponseEntity.ok().body(result) :
+            ResponseEntity.noContent().build();
+    }
+
+    @GetMapping(value = "/studies/{studyUuid}/nodes/{nodeUuid}/state-estimation/status")
+    @Operation(summary = "Get the state estimation status on study")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The state estimation status"),
+        @ApiResponse(responseCode = "204", description = "No state estimation has been done yet"),
+        @ApiResponse(responseCode = "404", description = "The state estimation status has not been found")})
+    public ResponseEntity<String> getStateEstimationStatus(@Parameter(description = "Study UUID") @PathVariable("studyUuid") UUID studyUuid,
+                                                            @Parameter(description = "nodeUuid") @PathVariable("nodeUuid") UUID nodeUuid) {
+        String status = stateEstimationService.getStateEstimationStatus(nodeUuid);
+        return status != null ? ResponseEntity.ok().body(status) : ResponseEntity.noContent().build();
+    }
+
+    @PutMapping(value = "/studies/{studyUuid}/nodes/{nodeUuid}/state-estimation/stop")
+    @Operation(summary = "stop state estimation on study")
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The state estimation has been stopped")})
+    public ResponseEntity<Void> stopStateEstimation(@Parameter(description = "Study uuid") @PathVariable("studyUuid") UUID studyUuid,
+                                                     @Parameter(description = "nodeUuid") @PathVariable("nodeUuid") UUID nodeUuid) {
+        stateEstimationService.stopStateEstimation(studyUuid, nodeUuid);
+        return ResponseEntity.ok().build();
+    }
 }

src/main/java/org/gridsuite/study/server/StudyException.java

@@ -107,6 +107,9 @@ public enum Type {
         NOT_IMPLEMENTED,
         EVALUATE_FILTER_FAILED,
         GET_USER_PROFILE_FAILED,
+        STATE_ESTIMATION_RUNNING,
+        STATE_ESTIMATION_NOT_FOUND,
+        STATE_ESTIMATION_ERROR,
     }
 
     private final Type type;

src/main/java/org/gridsuite/study/server/SupervisionController.java

@@ -49,7 +49,7 @@ public SupervisionController(SupervisionService supervisionService, StudyService
 
     @DeleteMapping(value = "/computation/results")
     @Operation(summary = "delete all results of a given computation")
-    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "all loadflow results have been deleted")})
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "all computation results have been deleted")})
     public ResponseEntity<Integer> deleteComputationResults(@Parameter(description = "Computation type") @RequestParam("type") ComputationType computationType,
                                                            @Parameter(description = "Dry run") @RequestParam("dryRun") boolean dryRun) {
         return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).body(supervisionService.deleteComputationResults(computationType, dryRun));

src/main/java/org/gridsuite/study/server/dto/ComputationType.java

@@ -28,7 +28,10 @@ public enum ComputationType {
             NotificationService.UPDATE_TYPE_DYNAMIC_SIMULATION_FAILED),
     SHORT_CIRCUIT_ONE_BUS("One bus Short circuit analysis", "oneBusShortCircuitAnalysisResultUuid",
             NotificationService.UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_STATUS, NotificationService.UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_RESULT,
-            NotificationService.UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_FAILED);
+            NotificationService.UPDATE_TYPE_ONE_BUS_SHORT_CIRCUIT_FAILED),
+    STATE_ESTIMATION("State estimation", "stateEstimationResultUuid",
+        NotificationService.UPDATE_TYPE_STATE_ESTIMATION_STATUS, NotificationService.UPDATE_TYPE_STATE_ESTIMATION_RESULT,
+        NotificationService.UPDATE_TYPE_STATE_ESTIMATION_FAILED);
 
     private final String label; // used for logs
     private final String resultUuidLabel;

src/main/java/org/gridsuite/study/server/dto/DeleteNodeInfos.java

@@ -43,6 +43,8 @@ public class DeleteNodeInfos {
     private List<UUID> voltageInitResultUuids = new ArrayList<>();
     private List<UUID> dynamicSimulationResultUuids = new ArrayList<>();
 
+    private List<UUID> stateEstimationResultUuids = new ArrayList<>();
+
     public void addModificationGroupUuid(UUID modificationGroupUuid) {
         modificationGroupUuids.add(modificationGroupUuid);
     }
@@ -86,4 +88,8 @@ public void addOneBusShortCircuitAnalysisResultUuid(UUID oneBusShortCircuitAnaly
     public void addVoltageInitResultUuid(UUID voltageInitResultUuid) {
         voltageInitResultUuids.add(voltageInitResultUuid);
     }
+
+    public void addStateEstimationResultUuid(UUID stateEstimationResultUuid) {
+        stateEstimationResultUuids.add(stateEstimationResultUuid);
+    }
 }

src/main/java/org/gridsuite/study/server/dto/InvalidateNodeInfos.java

@@ -46,6 +46,8 @@ public class InvalidateNodeInfos {
     private List<UUID> voltageInitResultUuids = new ArrayList<>();
     private List<UUID> dynamicSimulationResultUuids = new ArrayList<>();
 
+    private List<UUID> stateEstimationResultUuids = new ArrayList<>();
+
     public void addReportUuid(UUID reportUuid) {
         reportUuids.add(reportUuid);
     }
@@ -92,4 +94,8 @@ public void addVoltageInitResultUuid(UUID voltageInitResultUuid) {
     public void addDynamicSimulationResultUuid(UUID dynamicSimulationResultUuid) {
         dynamicSimulationResultUuids.add(dynamicSimulationResultUuid);
     }
+
+    public void addStateEstimationResultUuid(UUID stateEstimationResultUuid) {
+        stateEstimationResultUuids.add(stateEstimationResultUuid);
+    }
 }

src/main/java/org/gridsuite/study/server/dto/NodeModificationInfos.java

@@ -40,4 +40,6 @@ public class NodeModificationInfos {
     private UUID voltageInitUuid;
 
     private UUID dynamicSimulationUuid;
+
+    private UUID stateEstimationUuid;
 }

src/main/java/org/gridsuite/study/server/dto/StateEstimationStatus.java

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.gridsuite.study.server.dto;
+
+/**
+ * @author Franck Lecuyer <franck.lecuyer at rte-france.com>
+ */
+public enum StateEstimationStatus {
+    NOT_DONE,
+    RUNNING,
+    COMPLETED,
+}