Create action to change shunt compensator position

security-analysis/security-analysis-api/src/main/java/com/powsybl/security/action/ShuntCompensatorPositionAction.java

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) 2023, 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.security.action;
+
+/**
+ * @author Miora Vedelago <miora.ralambotiana at rte-france.com>
+ */
+public class ShuntCompensatorPositionAction extends AbstractAction {
+
+    public static final String NAME = "SHUNT_COMPENSATOR_POSITION";
+
+    private final String shuntCompensatorId;
+    private final int sectionCount;
+
+    ShuntCompensatorPositionAction(String id, String shuntCompensatorId, int sectionCount) {
+        super(id);
+        this.shuntCompensatorId = shuntCompensatorId;
+        this.sectionCount = sectionCount;
+    }
+
+    @Override
+    public String getType() {
+        return NAME;
+    }
+
+    public String getShuntCompensatorId() {
+        return shuntCompensatorId;
+    }
+
+    public int getSectionCount() {
+        return sectionCount;
+    }
+}

security-analysis/security-analysis-api/src/main/java/com/powsybl/security/action/ShuntCompensatorPositionActionBuilder.java

@@ -0,0 +1,43 @@
+/**
+ * Copyright (c) 2023, 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.security.action;
+
+/**
+ * @author Miora Vedelago <miora.ralambotiana at rte-france.com>
+ */
+public class ShuntCompensatorPositionActionBuilder {
+
+    private String id;
+    private String shuntCompensatorId;
+    private Integer sectionCount = null;
+
+    public ShuntCompensatorPositionAction build() {
+        if (sectionCount == null) {
+            throw new IllegalArgumentException("sectionCount in undefined");
+        }
+        if (sectionCount < 0) {
+            throw new IllegalArgumentException("sectionCount should be positive for a shunt compensator");
+        }
+        return new ShuntCompensatorPositionAction(id, shuntCompensatorId, sectionCount);
+    }
+
+    public ShuntCompensatorPositionActionBuilder withId(String id) {
+        this.id = id;
+        return this;
+    }
+
+    public ShuntCompensatorPositionActionBuilder withShuntCompensatorId(String shuntCompensatorId) {
+        this.shuntCompensatorId = shuntCompensatorId;
+        return this;
+    }
+
+    public ShuntCompensatorPositionActionBuilder withSectionCount(int sectionCount) {
+        this.sectionCount = sectionCount;
+        return this;
+    }
+}

security-analysis/security-analysis-api/src/main/java/com/powsybl/security/json/SecurityAnalysisJsonModule.java

@@ -107,6 +107,12 @@ private void configureActionsSerialization() {
         registerActionType(GeneratorAction.class, GeneratorAction.NAME, new GeneratorActionSerializer(), new GeneratorActionDeserializer());
         registerActionType(LoadAction.class, LoadAction.NAME, new LoadActionSerializer(), new LoadActionDeserializer());
         registerActionType(HvdcAction.class, HvdcAction.NAME, new HvdcActionSerializer(), new HvdcActionDeserializer());
+        registerActionType(GeneratorAction.class, GeneratorAction.NAME,
+                new GeneratorActionSerializer(), new GeneratorActionDeserializer());
+        registerActionType(LoadAction.class, LoadAction.NAME,
+                new LoadActionSerializer(), new LoadActionDeserializer());
+        registerActionType(ShuntCompensatorPositionAction.class, ShuntCompensatorPositionAction.NAME,
+                new ShuntCompensatorPositionActionSerializer(), new ShuntCompensatorPositionActionDeserializer());
     }
 
     private <T> void registerActionType(Class<T> actionClass, String typeName, JsonSerializer<T> serializer, JsonDeserializer<T> deserializer) {

security-analysis/security-analysis-api/src/main/java/com/powsybl/security/json/action/ShuntCompensatorPositionActionDeserializer.java

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2023, 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.security.json.action;
+
+import com.fasterxml.jackson.core.JacksonException;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+import com.powsybl.commons.json.JsonUtil;
+import com.powsybl.security.action.ShuntCompensatorPositionAction;
+import com.powsybl.security.action.ShuntCompensatorPositionActionBuilder;
+
+import java.io.IOException;
+
+/**
+ * @author Miora Vedelago <miora.ralambotiana at rte-france.com>
+ */
+public class ShuntCompensatorPositionActionDeserializer extends StdDeserializer<ShuntCompensatorPositionAction> {
+
+    public ShuntCompensatorPositionActionDeserializer() {
+        super(ShuntCompensatorPositionAction.class);
+    }
+
+    private static class ParsingContext {
+        String id;
+        String shuntCompensatorId;
+        Integer sectionCount = null;
+    }
+
+    @Override
+    public ShuntCompensatorPositionAction deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JacksonException {
+        ParsingContext context = new ParsingContext();
+        JsonUtil.parsePolymorphicObject(jsonParser, name -> {
+            switch (name) {
+                case "type":
+                    if (!ShuntCompensatorPositionAction.NAME.equals(jsonParser.nextTextValue())) {
+                        throw JsonMappingException.from(jsonParser, "Expected type " + ShuntCompensatorPositionAction.NAME);
+                    }
+                    return true;
+                case "id":
+                    context.id = jsonParser.nextTextValue();
+                    return true;
+                case "shuntCompensatorId":
+                    context.shuntCompensatorId = jsonParser.nextTextValue();
+                    return true;
+                case "sectionCount":
+                    jsonParser.nextToken();
+                    context.sectionCount = jsonParser.getValueAsInt();
+                    return true;
+                default:
+                    return false;
+            }
+        });
+        return new ShuntCompensatorPositionActionBuilder()
+                .withId(context.id)
+                .withShuntCompensatorId(context.shuntCompensatorId)
+                .withSectionCount(context.sectionCount)
+                .build();
+    }
+}

security-analysis/security-analysis-api/src/main/java/com/powsybl/security/json/action/ShuntCompensatorPositionActionSerializer.java

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) 2023, 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/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.security.json.action;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.ser.std.StdSerializer;
+import com.powsybl.security.action.ShuntCompensatorPositionAction;
+
+import java.io.IOException;
+
+/**
+ * @author Miora Vedelago <miora.ralambotiana at rte-france.com>
+ */
+public class ShuntCompensatorPositionActionSerializer extends StdSerializer<ShuntCompensatorPositionAction> {
+
+    public ShuntCompensatorPositionActionSerializer() {
+        super(ShuntCompensatorPositionAction.class);
+    }
+
+    @Override
+    public void serialize(ShuntCompensatorPositionAction action, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
+        jsonGenerator.writeStartObject();
+        jsonGenerator.writeStringField("type", action.getType());
+        jsonGenerator.writeStringField("id", action.getId());
+        jsonGenerator.writeStringField("shuntCompensatorId", action.getShuntCompensatorId());
+        jsonGenerator.writeNumberField("sectionCount", action.getSectionCount());
+        jsonGenerator.writeEndObject();
+    }
+}

security-analysis/security-analysis-api/src/test/java/com/powsybl/security/json/JsonActionAndOperatorStrategyTest.java

@@ -95,6 +95,7 @@ void actionRoundTrip() throws IOException {
                 .withActivePowerSetpoint(12.0)
                 .withRelativeValue(true)
                 .build());
+        actions.add(new ShuntCompensatorPositionActionBuilder().withId("id22").withShuntCompensatorId("shuntId1").withSectionCount(5).build());
         ActionList actionList = new ActionList(actions);
         roundTripTest(actionList, ActionList::writeJsonFile, ActionList::readJsonFile, "/ActionFileTest.json");
     }

security-analysis/security-analysis-api/src/test/resources/ActionFileTest.json

@@ -162,5 +162,10 @@
     "acEmulationEnabled" : false,
     "activePowerSetpoint" : 12.0,
     "relativeValue" : true
+  }, {
+    "type" : "SHUNT_COMPENSATOR_POSITION",
+    "id" : "id22",
+    "shuntCompensatorId" : "shuntId1",
+    "sectionCount" : 5
   } ]
 }

security-analysis/security-analysis-api/src/test/resources/ActionFileTestV1.0.json

@@ -1,5 +1,5 @@
 {
-  "version" : "1.0",
+  "version" : "1.1",
   "actions" : [ {
     "type" : "SWITCH",
     "id" : "id1",
@@ -30,27 +30,27 @@
     "type" : "PHASE_TAP_CHANGER_TAP_POSITION",
     "id" : "id5",
     "transformerId" : "transformerId1",
-    "value" : 5,
+    "tapPosition" : 5,
     "relativeValue" : true,
     "side" : "TWO"
   }, {
     "type" : "PHASE_TAP_CHANGER_TAP_POSITION",
     "id" : "id6",
     "transformerId" : "transformerId2",
-    "value" : 12,
+    "tapPosition" : 12,
     "relativeValue" : false
   }, {
     "type" : "PHASE_TAP_CHANGER_TAP_POSITION",
     "id" : "id7",
     "transformerId" : "transformerId3",
-    "value" : -5,
+    "tapPosition" : -5,
     "relativeValue" : true,
     "side" : "ONE"
   }, {
     "type" : "PHASE_TAP_CHANGER_TAP_POSITION",
     "id" : "id8",
     "transformerId" : "transformerId3",
-    "value" : 2,
+    "tapPosition" : 2,
     "relativeValue" : false,
     "side" : "THREE"
   }, {
@@ -87,14 +87,14 @@
     "type" : "RATIO_TAP_CHANGER_TAP_POSITION",
     "id" : "id14",
     "transformerId" : "transformerId4",
-    "value" : 2,
+    "tapPosition" : 2,
     "relativeValue" : false,
     "side" : "THREE"
   }, {
     "type" : "RATIO_TAP_CHANGER_TAP_POSITION",
     "id" : "id15",
     "transformerId" : "transformerId5",
-    "value" : 1,
+    "tapPosition" : 1,
     "relativeValue" : true
   }, {
     "type" : "RATIO_TAP_CHANGER_REGULATION",
@@ -162,5 +162,10 @@
     "acEmulationEnabled" : false,
     "activePowerSetpoint" : 12.0,
     "relativeValue" : true
+  }, {
+    "type" : "SHUNT_COMPENSATOR_POSITION",
+    "id" : "id22",
+    "shuntCompensatorId" : "shuntId1",
+    "sectionCount" : 5
   } ]
 }