Migration powsybl dependencies 2025.0.0

dictionary.properties

@@ -0,0 +1,5 @@
+core.iidm.network.alreadyConnectedTerminal = A terminal of identifiable ${identifiable} is already connected.
+core.iidm.network.alreadyDisconnectedTerminal = A terminal of identifiable ${identifiable} is already disconnected.
+regulatedTerminalDeleted = ${identifiableId} has been deleted and it was regulated. The following regulating equipments have their regulation set to Local : [${regulatingEquipments}]
+resetPhaseTapChangerRegulationMode = Regulation mode of phase tap changer of ${identifiableId} has been reset to FIXED TAP due to deletion of its regulating terminal
+resetSVCRegulationMode = Regulation mode of static var compensator ${identifiableId} has been reset to OFF due to deletion of its regulating terminal

network-store-client/src/main/java/com/powsybl/network/store/client/BufferedNetworkStoreClient.java

@@ -109,8 +109,8 @@ public class BufferedNetworkStoreClient extends AbstractForwardingNetworkStoreCl
 
     private final NetworkCollectionIndex<CollectionBuffer<GroundAttributes>> groundResourcesToFlush
             = new NetworkCollectionIndex<>(() -> new CollectionBuffer<>(delegate::createGrounds,
-            delegate::updateGrounds,
-            delegate::removeGrounds));
+                delegate::updateGrounds,
+                delegate::removeGrounds));
 
     private final NetworkCollectionIndex<CollectionBuffer<TwoWindingsTransformerAttributes>> twoWindingsTransformerResourcesToFlush
             = new NetworkCollectionIndex<>(() -> new CollectionBuffer<>(delegate::createTwoWindingsTransformers,
@@ -134,8 +134,13 @@ public class BufferedNetworkStoreClient extends AbstractForwardingNetworkStoreCl
 
     private final NetworkCollectionIndex<CollectionBuffer<TieLineAttributes>> tieLineResourcesToFlush
             = new NetworkCollectionIndex<>(() -> new CollectionBuffer<>(delegate::createTieLines,
-            delegate::updateTieLines,
-            delegate::removeTieLines));
+                delegate::updateTieLines,
+                delegate::removeTieLines));
+
+    private final NetworkCollectionIndex<CollectionBuffer<AreaAttributes>> areaResourcesToFlush
+            = new NetworkCollectionIndex<>(() -> new CollectionBuffer<>(delegate::createAreas,
+                delegate::updateAreas,
+                delegate::removeAreas));
 
     private final List<NetworkCollectionIndex<? extends CollectionBuffer<? extends IdentifiableAttributes>>> allBuffers = List.of(
             networkResourcesToFlush,
@@ -157,7 +162,8 @@ public class BufferedNetworkStoreClient extends AbstractForwardingNetworkStoreCl
             threeWindingsTransformerResourcesToFlush,
             lineResourcesToFlush,
             busResourcesToFlush,
-            tieLineResourcesToFlush);
+            tieLineResourcesToFlush,
+            areaResourcesToFlush);
 
     private final ExecutorService executorService;
 
@@ -563,6 +569,26 @@ public void removeTieLines(UUID networkUuid, int variantNum, List<String> tieLin
         tieLineResourcesToFlush.getCollection(networkUuid, variantNum).remove(tieLinesId);
     }
 
+    // Areas
+    @Override
+    public void createAreas(UUID networkUuid, List<Resource<AreaAttributes>> areaResources) {
+        for (Resource<AreaAttributes> areaResource : areaResources) {
+            areaResourcesToFlush.getCollection(networkUuid, areaResource.getVariantNum()).create(areaResource);
+        }
+    }
+
+    @Override
+    public void updateAreas(UUID networkUuid, List<Resource<AreaAttributes>> areaResources, AttributeFilter attributeFilter) {
+        for (Resource<AreaAttributes> areaResource : areaResources) {
+            areaResourcesToFlush.getCollection(networkUuid, areaResource.getVariantNum()).update(areaResource, attributeFilter);
+        }
+    }
+
+    @Override
+    public void removeAreas(UUID networkUuid, int variantNum, List<String> areasId) {
+        areaResourcesToFlush.getCollection(networkUuid, variantNum).remove(areasId);
+    }
+
     @Override
     public void flush(UUID networkUuid) {
         Stopwatch stopwatch = Stopwatch.createStarted();
@@ -618,6 +644,7 @@ public void cloneNetwork(UUID networkUuid, int sourceVariantNum, int targetVaria
         cloneBuffer(substationResourcesToFlush, networkUuid, sourceVariantNum, targetVariantNum, objectMapper);
         cloneBuffer(voltageLevelResourcesToFlush, networkUuid, sourceVariantNum, targetVariantNum, objectMapper);
         cloneBuffer(tieLineResourcesToFlush, networkUuid, sourceVariantNum, targetVariantNum, objectMapper);
+        cloneBuffer(areaResourcesToFlush, networkUuid, sourceVariantNum, targetVariantNum, objectMapper);
         cloneBuffer(networkResourcesToFlush, networkUuid, sourceVariantNum, targetVariantNum, objectMapper,
                 networkResource -> {
                     NetworkAttributes networkAttributes = networkResource.getAttributes();

network-store-client/src/main/java/com/powsybl/network/store/client/RestNetworkStoreClient.java

@@ -54,6 +54,7 @@ public class RestNetworkStoreClient implements NetworkStoreClient {
     private static final String STR_DANGLING_LINE = "dangling line";
     private static final String STR_HVDC_LINE = "hvdc line";
     private static final String STR_TIE_LINE = "tie line";
+    private static final String STR_AREA = "area";
     private static final String STR_GROUND = "ground";
 
     private final RestClient restClient;
@@ -878,6 +879,32 @@ public void updateTieLines(UUID networkUuid, List<Resource<TieLineAttributes>> t
         updateAll(STR_TIE_LINE, "/networks/{networkUuid}/tie-lines", tieLineResources, attributeFilter, networkUuid);
     }
 
+    // Areas
+    @Override
+    public void createAreas(UUID networkUuid, List<Resource<AreaAttributes>> areaResources) {
+        create(STR_AREA, "/networks/{networkUuid}/areas", areaResources, networkUuid);
+    }
+
+    @Override
+    public List<Resource<AreaAttributes>> getAreas(UUID networkUuid, int variantNum) {
+        return getAll(STR_AREA, "/networks/{networkUuid}/{variantNum}/areas", networkUuid, variantNum);
+    }
+
+    @Override
+    public Optional<Resource<AreaAttributes>> getArea(UUID networkUuid, int variantNum, String areaId) {
+        return get(STR_AREA, "/networks/{networkUuid}/{variantNum}/areas/{AreaId}", networkUuid, variantNum, areaId);
+    }
+
+    @Override
+    public void removeAreas(UUID networkUuid, int variantNum, List<String> areasIds) {
+        removeAll(STR_AREA, "/networks/{networkUuid}/{variantNum}/areas", networkUuid, variantNum, areasIds);
+    }
+
+    @Override
+    public void updateAreas(UUID networkUuid, List<Resource<AreaAttributes>> areaResources, AttributeFilter attributeFilter) {
+        updateAll(STR_AREA, "/networks/{networkUuid}/areas", areaResources, attributeFilter, networkUuid);
+    }
+
     @Override
     public Optional<Resource<IdentifiableAttributes>> getIdentifiable(UUID networkUuid, int variantNum, String id) {
         return get("identifiable", "/networks/{networkUuid}/{variantNum}/identifiables/{id}", networkUuid, variantNum, id);

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/AbstractIdentifiableImpl.java

@@ -111,13 +111,17 @@ public Resource<D> getNullableResource() {
     }
 
     public void setResource(Resource<D> resource) {
-        idBeforeRemoval = resource == null ? this.resource.getId() : null;
+        idBeforeRemoval = resource == null && this.resource != null ? this.resource.getId() : null;
         this.resource = resource;
     }
 
     public Resource<D> getResource() {
+        return getResource("Object has been removed in current variant");
+    }
+
+    public Resource<D> getResource(String errorMessageIfResourceNull) {
         if (resource == null) {
-            throw new PowsyblException("Object has been removed in current variant");
+            throw new PowsyblException(errorMessageIfResourceNull);
         }
         if (index.getWorkingVariantNum() == -1) {
             throw new PowsyblException("Variant index not set");

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/AreaAdderImpl.java

@@ -0,0 +1,93 @@
+/**
+ * Copyright (c) 2025, 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 com.powsybl.network.store.iidm.impl;
+
+import com.powsybl.iidm.network.*;
+import com.powsybl.network.store.model.AreaAttributes;
+import com.powsybl.network.store.model.Resource;
+import com.powsybl.network.store.model.ResourceType;
+
+import java.util.*;
+
+/**
+ * @author Etienne Lesot <etienne.lesot at rte-france.com>
+ */
+public class AreaAdderImpl extends AbstractIdentifiableAdder<AreaAdderImpl> implements AreaAdder {
+
+    private String areaType;
+    private final Map<Terminal, Boolean> terminalAreaBoundaries;
+    private final Map<Boundary, Boolean> boundaryAreaBoundaries;
+    private final Set<String> voltageLevelIds;
+    private double interchangeTarget;
+
+    AreaAdderImpl(NetworkObjectIndex index) {
+        super(index);
+        terminalAreaBoundaries = new HashMap<>();
+        boundaryAreaBoundaries = new HashMap<>();
+        voltageLevelIds = new HashSet<>();
+        interchangeTarget = Double.NaN;
+    }
+
+    @Override
+    public AreaAdderImpl setAreaType(String areaType) {
+        this.areaType = areaType;
+        return this;
+    }
+
+    @Override
+    public AreaAdder setInterchangeTarget(double v) {
+        interchangeTarget = v;
+        return this;
+    }
+
+    @Override
+    public AreaAdder addVoltageLevel(VoltageLevel voltageLevel) {
+        voltageLevelIds.add(voltageLevel.getId());
+        return this;
+    }
+
+    @Override
+    public AreaAdder addAreaBoundary(Terminal terminal, boolean ac) {
+        terminalAreaBoundaries.put(terminal, ac);
+        return this;
+    }
+
+    @Override
+    public AreaAdder addAreaBoundary(Boundary boundary, boolean ac) {
+        boundaryAreaBoundaries.put(boundary, ac);
+        return this;
+    }
+
+    @Override
+    public Area add() {
+        String id = checkAndGetUniqueId();
+        Resource<AreaAttributes> resource = Resource.areaBuilder()
+            .id(id)
+            .variantNum(index.getWorkingVariantNum())
+            .attributes(AreaAttributes.builder()
+                .name(getName())
+                .fictitious(isFictitious())
+                .areaType(areaType)
+                .interchangeTarget(interchangeTarget)
+                .voltageLevelIds(new LinkedHashSet<>())
+                .areaBoundaries(new ArrayList<>())
+                .build())
+            .build();
+        AreaImpl area = getIndex().createArea(resource);
+        terminalAreaBoundaries.forEach((terminal, ac) -> area.newAreaBoundary().setTerminal(terminal).setAc(ac).add());
+        boundaryAreaBoundaries.forEach((boundary, ac) -> area.newAreaBoundary().setBoundary(boundary).setAc(ac).add());
+        voltageLevelIds.forEach(voltageLevelId -> index.getVoltageLevel(voltageLevelId)
+            .ifPresent(voltageLevel -> voltageLevel.addArea(area)));
+        return area;
+    }
+
+    @Override
+    protected String getTypeDescription() {
+        return ResourceType.AREA.getDescription();
+    }
+
+}

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/AreaBoundaryAdderImpl.java

@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) 2025, 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 com.powsybl.network.store.iidm.impl;
+
+import com.powsybl.commons.PowsyblException;
+import com.powsybl.iidm.network.Area;
+import com.powsybl.iidm.network.AreaBoundaryAdder;
+import com.powsybl.iidm.network.Boundary;
+import com.powsybl.iidm.network.Terminal;
+import com.powsybl.network.store.model.AreaBoundaryAttributes;
+import com.powsybl.network.store.model.TerminalRefAttributes;
+
+import java.util.Objects;
+
+/**
+ * @author Etienne Lesot <etienne.lesot at rte-france.com>
+ */
+public class AreaBoundaryAdderImpl implements AreaBoundaryAdder {
+    AreaImpl area;
+
+    Boundary boundary;
+
+    Terminal terminal;
+
+    Boolean ac;
+
+    NetworkObjectIndex index;
+
+    AreaBoundaryAdderImpl(AreaImpl area, NetworkObjectIndex index) {
+        this.area = Objects.requireNonNull(area);
+        this.index = Objects.requireNonNull(index);
+    }
+
+    @Override
+    public AreaBoundaryAdder setBoundary(Boundary boundary) {
+        this.boundary = boundary;
+        this.terminal = null;
+        return this;
+    }
+
+    @Override
+    public AreaBoundaryAdder setTerminal(Terminal terminal) {
+        this.terminal = terminal;
+        this.boundary = null;
+        return this;
+    }
+
+    @Override
+    public AreaBoundaryAdder setAc(boolean ac) {
+        this.ac = ac;
+        return this;
+    }
+
+    @Override
+    public Area add() {
+        if (ac == null) {
+            throw new PowsyblException("AreaBoundary AC flag is not set.");
+        }
+        // we remove before adding, to forbid duplicates and allow updating ac to true/false
+        AreaBoundaryAttributes areaBoundaryAttributes;
+        if (boundary != null) {
+            areaBoundaryAttributes = new AreaBoundaryAttributes(null, ac, area.getId(), boundary.getDanglingLine().getId());
+            area.removeAreaBoundary(boundary);
+        } else if (terminal != null) {
+            TerminalRefAttributes terminalRefAttributes = TerminalRefUtils.getTerminalRefAttributes(terminal);
+            areaBoundaryAttributes = new AreaBoundaryAttributes(terminalRefAttributes, ac, area.getId(), null);
+            area.removeAreaBoundary(terminal);
+        } else {
+            throw new PowsyblException("No AreaBoundary element (terminal or boundary) is set.");
+        }
+        area.addAreaBoundary(new AreaBoundaryImpl(areaBoundaryAttributes, index));
+        return area;
+    }
+}

network-store-iidm-impl/src/main/java/com/powsybl/network/store/iidm/impl/AreaBoundaryImpl.java

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) 2025, 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 com.powsybl.network.store.iidm.impl;
+
+import com.powsybl.iidm.network.Area;
+import com.powsybl.iidm.network.AreaBoundary;
+import com.powsybl.iidm.network.Boundary;
+import com.powsybl.iidm.network.Terminal;
+import com.powsybl.iidm.network.util.DanglingLineBoundaryImpl;
+import com.powsybl.network.store.model.AreaBoundaryAttributes;
+import com.powsybl.network.store.model.TerminalRefAttributes;
+
+import java.util.Optional;
+
+/**
+ * @author Etienne Lesot <etienne.lesot at rte-france.com>
+ */
+public class AreaBoundaryImpl implements AreaBoundary {
+
+    protected final NetworkObjectIndex index;
+
+    private final AreaBoundaryAttributes areaBoundaryAttributes;
+
+    protected AreaBoundaryImpl(AreaBoundaryAttributes areaBoundaryAttributes, NetworkObjectIndex index) {
+        this.index = index;
+        this.areaBoundaryAttributes = areaBoundaryAttributes;
+    }
+
+    @Override
+    public Area getArea() {
+        return this.index.getArea(areaBoundaryAttributes.getAreaId()).orElse(null);
+    }
+
+    @Override
+    public Optional<Terminal> getTerminal() {
+        return Optional.ofNullable(getRefTerminal());
+    }
+
+    private Terminal getRefTerminal() {
+        TerminalRefAttributes terminalRefAttributes = areaBoundaryAttributes.getTerminal();
+        return TerminalRefUtils.getTerminal(index, terminalRefAttributes);
+    }
+
+    @Override
+    public Optional<Boundary> getBoundary() {
+        if (areaBoundaryAttributes.getBoundaryDanglingLineId() == null) {
+            return Optional.empty();
+        }
+        Optional<DanglingLineImpl> danglingLine = index.getDanglingLine(areaBoundaryAttributes.getBoundaryDanglingLineId());
+        return danglingLine.map(DanglingLineBoundaryImpl::new);
+    }
+
+    @Override
+    public boolean isAc() {
+        return areaBoundaryAttributes.getAc();
+    }
+
+    @Override
+    public double getP() {
+        return getBoundary().map(Boundary::getP).orElseGet(() -> getRefTerminal().getP());
+    }
+
+    @Override
+    public double getQ() {
+        return getBoundary().map(Boundary::getQ).orElseGet(() -> getRefTerminal().getQ());
+    }
+}