Merge branch 'main' into nad_metadata_layout

Signed-off-by: Florian Dupuy <[email protected]>
powsybl · Dec 16, 2024 · 504e794 · 504e794
2 parents bc99bda + f81d978
commit 504e794
Show file tree

Hide file tree

Showing 17 changed files with 1,118 additions and 27 deletions.
diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/model/AbstractNode.java b/network-area-diagram/src/main/java/com/powsybl/nad/model/AbstractNode.java
@@ -14,12 +14,14 @@ public abstract class AbstractNode extends AbstractIdentifiable implements Node
     private int width;
     private int height;
     private Point position;
+    private final boolean fictitious;
 
-    protected AbstractNode(String diagramId, String equipmentId, String name) {
+    protected AbstractNode(String diagramId, String equipmentId, String name, boolean fictitious) {
         super(diagramId, equipmentId, name);
         position = new Point();
         width = 0;
         height = 0;
+        this.fictitious = fictitious;
     }
 
     @Override
@@ -47,6 +49,11 @@ public double getY() {
         return position.getY();
     }
 
+    @Override
+    public boolean isFictitious() {
+        return fictitious;
+    }
+
     public int getWidth() {
         return width;
     }

diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/model/BusNode.java b/network-area-diagram/src/main/java/com/powsybl/nad/model/BusNode.java
@@ -18,7 +18,7 @@ public class BusNode extends AbstractNode {
     private int nbNeighbouringBusNodes;
 
     public BusNode(String diagramId, String id) {
-        super(diagramId, id, null);
+        super(diagramId, id, null, false);
     }
 
     public void setRingIndex(int ringIndex) {

diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/model/Node.java b/network-area-diagram/src/main/java/com/powsybl/nad/model/Node.java
@@ -20,4 +20,6 @@ public interface Node extends Identifiable {
     double getX();
 
     double getY();
+
+    boolean isFictitious();
 }
diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/model/TextNode.java b/network-area-diagram/src/main/java/com/powsybl/nad/model/TextNode.java
@@ -14,7 +14,7 @@ public class TextNode extends AbstractNode {
     private Point edgeConnection;
 
     public TextNode(String diagramId) {
-        super(diagramId, null, null);
+        super(diagramId, null, null, false);
         edgeConnection = new Point();
     }
 

diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/model/ThreeWtNode.java b/network-area-diagram/src/main/java/com/powsybl/nad/model/ThreeWtNode.java
@@ -12,7 +12,7 @@
 public class ThreeWtNode extends AbstractNode {
 
     public ThreeWtNode(String diagramId, String equipmentId, String nameOrId) {
-        super(diagramId, equipmentId, nameOrId);
+        super(diagramId, equipmentId, nameOrId, false);
     }
 
 }
diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/model/VoltageLevelNode.java b/network-area-diagram/src/main/java/com/powsybl/nad/model/VoltageLevelNode.java
@@ -15,7 +15,6 @@
 public class VoltageLevelNode extends AbstractNode {
 
     private final List<BusNode> busNodes = new ArrayList<>();
-    private final boolean fictitious;
     private final boolean visible;
     private boolean hasUnknownBusNode = false;
 
@@ -24,8 +23,7 @@ public VoltageLevelNode(String diagramId, String equipmentId, String nameOrId, b
     }
 
     public VoltageLevelNode(String diagramId, String equipmentId, String nameOrId, boolean fictitious, boolean visible) {
-        super(diagramId, equipmentId, nameOrId);
-        this.fictitious = fictitious;
+        super(diagramId, equipmentId, nameOrId, fictitious);
         this.visible = visible;
     }
 
@@ -57,8 +55,4 @@ public void setHasUnknownBusNode(boolean hasUnknownBusNode) {
     public boolean hasUnknownBusNode() {
         return hasUnknownBusNode;
     }
-
-    public boolean isFictitious() {
-        return fictitious;
-    }
 }
diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/svg/metadata/DiagramMetadata.java b/network-area-diagram/src/main/java/com/powsybl/nad/svg/metadata/DiagramMetadata.java
@@ -112,7 +112,8 @@ public DiagramMetadata addMetadata(Graph graph) {
                 getPrefixedId(node.getDiagramId()),
                 node.getEquipmentId(),
                 round(node.getX()),
-                round(node.getY()))));
+                round(node.getY()),
+                node.isFictitious())));
         graph.getBranchEdgeStream().forEach(edge -> edgesMetadata.add(new EdgeMetadata(
                 getPrefixedId(edge.getDiagramId()),
                 edge.getEquipmentId(),

diff --git a/network-area-diagram/src/main/java/com/powsybl/nad/svg/metadata/NodeMetadata.java b/network-area-diagram/src/main/java/com/powsybl/nad/svg/metadata/NodeMetadata.java
@@ -20,14 +20,17 @@ public class NodeMetadata extends AbstractMetadataItem {
 
     private final double x;
     private final double y;
+    private final boolean fictitious;
 
     public NodeMetadata(@JsonProperty("svgId") String svgId,
                         @JsonProperty("equipmentId") String equipmentId,
                         @JsonProperty("x") double x,
-                        @JsonProperty("y") double y) {
+                        @JsonProperty("y") double y,
+                        @JsonProperty("fictitious") boolean fictitious) {
         super(svgId, equipmentId);
         this.x = x;
         this.y = y;
+        this.fictitious = fictitious;
     }
 
     public double getX() {
@@ -38,6 +41,11 @@ public double getY() {
         return y;
     }
 
+    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
+    public boolean isFictitious() {
+        return fictitious;
+    }
+
     @JsonIgnore
     public Point getPosition() {
         return new Point(x, y);

diff --git a/network-area-diagram/src/test/java/com/powsybl/nad/svg/DiagramMetadataTest.java b/network-area-diagram/src/test/java/com/powsybl/nad/svg/DiagramMetadataTest.java
@@ -9,6 +9,7 @@
 
 import com.google.common.jimfs.Configuration;
 import com.google.common.jimfs.Jimfs;
+import com.powsybl.ieeecdf.converter.IeeeCdfNetworkFactory;
 import com.powsybl.iidm.network.Network;
 import com.powsybl.iidm.network.test.ThreeWindingsTransformerNetworkFactory;
 import com.powsybl.nad.AbstractTest;
@@ -86,12 +87,22 @@ void test() {
 
     @Test
     void test3wt() {
-        // Referenced json file
-        String referenceMetadata = "/3wt_metadata.json";
-        // Write Metadata as temporary json file
         Network network = ThreeWindingsTransformerNetworkFactory.create();
+        testMetadata(network, "/3wt_metadata.json", 3, 4, 3, 3);
+    }
+
+    @Test
+    void testFictitious() {
+        Network network = IeeeCdfNetworkFactory.create14();
+        network.getVoltageLevel("VL12").setFictitious(true);
+        network.getVoltageLevel("VL14").setFictitious(true);
+        testMetadata(network, "/IEEE_14_bus_fictitious_metadata.json", 14, 14, 20, 14);
+    }
+
+    private void testMetadata(Network network, String referenceMetadata, int busNodesNumber, int nodesNumber, int edgesNumber, int textNodesNumber) {
         Graph graph = new NetworkGraphBuilder(network, VoltageLevelFilter.NO_FILTER).buildGraph();
         new BasicForceLayout().run(graph, getLayoutParameters());
+        // Write Metadata as temporary json file
         Path outMetadataPath = tmpDir.resolve("metadata.json");
         new DiagramMetadata(getLayoutParameters(), getSvgParameters()).addMetadata(graph).writeJson(outMetadataPath);
         // Read generated json file
@@ -102,10 +113,11 @@ void test3wt() {
         assertEquals(expected, actual);
         // Read metadata from file
         DiagramMetadata diagramMetadata = DiagramMetadata.parseJson(outMetadataPath);
-        assertEquals(3, diagramMetadata.getBusNodesMetadata().size());
-        assertEquals(4, diagramMetadata.getNodesMetadata().size());
-        assertEquals(3, diagramMetadata.getEdgesMetadata().size());
-        assertEquals(3, diagramMetadata.getTextNodesMetadata().size());
+        // Check read metadata
+        assertEquals(busNodesNumber, diagramMetadata.getBusNodesMetadata().size());
+        assertEquals(nodesNumber, diagramMetadata.getNodesMetadata().size());
+        assertEquals(edgesNumber, diagramMetadata.getEdgesMetadata().size());
+        assertEquals(textNodesNumber, diagramMetadata.getTextNodesMetadata().size());
     }
 
     private void writeMetadata(DiagramMetadata metadata, Path outPath) {