Zone diagram (multiple substations) on a substation grid

single-line-diagram/single-line-diagram-core/src/main/java/com/powsybl/sld/layout/AbstractZoneLayout.java

@@ -7,23 +7,30 @@
  */
 package com.powsybl.sld.layout;
 
-import com.powsybl.sld.model.graphs.SubstationGraph;
-import com.powsybl.sld.model.graphs.VoltageLevelGraph;
-import com.powsybl.sld.model.graphs.ZoneGraph;
+import com.powsybl.sld.layout.pathfinding.*;
+import com.powsybl.sld.model.graphs.*;
+import com.powsybl.sld.model.nodes.*;
 
-import java.util.Objects;
+import java.util.*;
 
 /**
  * @author Thomas Adam {@literal <tadam at silicom.fr>}
  */
 public abstract class AbstractZoneLayout extends AbstractBaseLayout<ZoneGraph> {
     protected SubstationLayoutFactory sLayoutFactory;
     protected VoltageLevelLayoutFactory vLayoutFactory;
+    protected Map<BaseGraph, AbstractLayout<SubstationGraph>> layoutBySubstation;
+    protected PathFinder pathFinder;
 
     protected AbstractZoneLayout(ZoneGraph graph, SubstationLayoutFactory sLayoutFactory, VoltageLevelLayoutFactory vLayoutFactory) {
         super(graph);
         this.sLayoutFactory = Objects.requireNonNull(sLayoutFactory);
         this.vLayoutFactory = Objects.requireNonNull(vLayoutFactory);
+        this.layoutBySubstation = new HashMap<>();
+        for (SubstationGraph subGraph : getGraph().getSubstations()) {
+            Layout sLayout = sLayoutFactory.create(subGraph, vLayoutFactory);
+            layoutBySubstation.put(subGraph, (AbstractLayout<SubstationGraph>) sLayout);
+        }
     }
 
     @Override
@@ -37,9 +44,19 @@ public void run(LayoutParameters layoutParameters) {
 
     protected abstract void calculateCoordSubstations(LayoutParameters layoutParameters);
 
-    protected void move(SubstationGraph subGraph, double dx, double dy) {
+    protected void move(BaseGraph subGraph, double dx, double dy) {
         for (VoltageLevelGraph vlGraph : subGraph.getVoltageLevels()) {
             vlGraph.setCoord(vlGraph.getX() + dx, vlGraph.getY() + dy);
+            vlGraph.getLineEdges().forEach(s -> s.shiftSnakeLine(dx, dy));
         }
+        subGraph.getMultiTermNodes().forEach(node -> {
+            node.setCoordinates(node.getX() + dx, node.getY() + dy);
+            node.getAdjacentEdges().forEach(edge -> {
+                if (edge instanceof BranchEdge branch) {
+                    branch.shiftSnakeLine(dx, dy);
+                }
+            });
+        });
+        subGraph.getLineEdges().forEach(s -> s.shiftSnakeLine(dx, dy));
     }
 }

single-line-diagram/single-line-diagram-core/src/main/java/com/powsybl/sld/layout/HorizontalZoneLayoutFactory.java

@@ -7,7 +7,7 @@
  */
 package com.powsybl.sld.layout;
 
-import com.powsybl.sld.model.graphs.ZoneGraph;
+import com.powsybl.sld.model.graphs.*;
 
 /**
  * @author Thomas Adam {@literal <tadam at silicom.fr>}
@@ -16,6 +16,6 @@ public class HorizontalZoneLayoutFactory implements ZoneLayoutFactory {
 
     @Override
     public Layout create(ZoneGraph graph, SubstationLayoutFactory sLayoutFactory, VoltageLevelLayoutFactory vLayoutFactory) {
-        return new HorizontalZoneLayout(graph, sLayoutFactory, vLayoutFactory);
+        return new MatrixZoneLayoutFactory().create(graph, sLayoutFactory, vLayoutFactory);
     }
 }

single-line-diagram/single-line-diagram-core/src/main/java/com/powsybl/sld/layout/LayoutParameters.java

@@ -48,6 +48,8 @@ public class LayoutParameters {
     private double cgmesScaleFactor = 1;
     private String cgmesDiagramName = null;
     private boolean cgmesUseNames = true;
+    private double zoneLayoutSnakeLinePadding = 90;
+    private PathFinderType zoneLayoutPathFinder = PathFinderType.DIJKSTRA;
 
     @JsonIgnore
     private Map<String, ComponentSize> componentsSize;
@@ -77,7 +79,9 @@ public LayoutParameters(@JsonProperty("verticalSpaceBus") double verticalSpaceBu
                             @JsonProperty("removeFictitiousSwitchNodes") boolean removeFictitiousSwitchNodes,
                             @JsonProperty("cgmesScaleFactor") double cgmesScaleFactor,
                             @JsonProperty("cgmesDiagramName") String cgmesDiagramName,
-                            @JsonProperty("cgmesUseNames") boolean cgmesUseNames) {
+                            @JsonProperty("cgmesUseNames") boolean cgmesUseNames,
+                            @JsonProperty("zoneLayoutSnakeLinePadding") int zoneLayoutSnakeLinePadding,
+                            @JsonProperty("zoneLayoutPathFinder") PathFinderType zoneLayoutPathFinder) {
 
         this.verticalSpaceBus = verticalSpaceBus;
         this.horizontalBusPadding = horizontalBusPadding;
@@ -100,6 +104,8 @@ public LayoutParameters(@JsonProperty("verticalSpaceBus") double verticalSpaceBu
         this.cgmesDiagramName = cgmesDiagramName;
         this.cgmesScaleFactor = cgmesScaleFactor;
         this.cgmesUseNames = cgmesUseNames;
+        this.zoneLayoutSnakeLinePadding = zoneLayoutSnakeLinePadding;
+        this.zoneLayoutPathFinder = zoneLayoutPathFinder;
     }
 
     public LayoutParameters(LayoutParameters other) {
@@ -126,6 +132,8 @@ public LayoutParameters(LayoutParameters other) {
         cgmesScaleFactor = other.cgmesScaleFactor;
         cgmesDiagramName = other.cgmesDiagramName;
         cgmesUseNames = other.cgmesUseNames;
+        zoneLayoutSnakeLinePadding = other.zoneLayoutSnakeLinePadding;
+        zoneLayoutPathFinder = other.zoneLayoutPathFinder;
     }
 
     public double getVerticalSpaceBus() {
@@ -330,8 +338,30 @@ public LayoutParameters setCgmesUseNames(boolean cgmesUseNames) {
         return this;
     }
 
+    public double getZoneLayoutSnakeLinePadding() {
+        return zoneLayoutSnakeLinePadding;
+    }
+
+    public LayoutParameters setZoneLayoutSnakeLinePadding(double zoneLayoutSnakeLinePadding) {
+        this.zoneLayoutSnakeLinePadding = zoneLayoutSnakeLinePadding;
+        return this;
+    }
+
+    public PathFinderType getZoneLayoutPathFinder() {
+        return zoneLayoutPathFinder;
+    }
+
+    public LayoutParameters setZoneLayoutPathFinder(PathFinderType zoneLayoutPathFinder) {
+        this.zoneLayoutPathFinder = zoneLayoutPathFinder;
+        return this;
+    }
+
+    public enum PathFinderType {
+        DIJKSTRA
+    }
+
     public enum Alignment {
-        FIRST, LAST, MIDDLE, NONE;
+        FIRST, LAST, MIDDLE, NONE
     }
 
     public static class Padding {

single-line-diagram/single-line-diagram-core/src/main/java/com/powsybl/sld/layout/MatrixZoneLayout.java

@@ -0,0 +1,120 @@
+/**
+ * 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.sld.layout;
+
+import com.powsybl.commons.*;
+import com.powsybl.sld.layout.pathfinding.*;
+import com.powsybl.sld.layout.zonebygrid.*;
+import com.powsybl.sld.model.coordinate.*;
+import com.powsybl.sld.model.coordinate.Point;
+import com.powsybl.sld.model.graphs.*;
+import com.powsybl.sld.model.nodes.Node;
+import org.jgrapht.alg.util.*;
+
+import java.util.*;
+
+/**
+ * @author Thomas Adam {@literal <tadam at neverhack.com>}
+ */
+public class MatrixZoneLayout extends AbstractZoneLayout {
+    private final MatrixZoneLayoutModel model;
+
+    protected MatrixZoneLayout(ZoneGraph graph, String[][] matrix, ZoneLayoutPathFinderFactory pathFinderFactory, SubstationLayoutFactory sLayoutFactory, VoltageLevelLayoutFactory vLayoutFactory) {
+        super(graph, sLayoutFactory, vLayoutFactory);
+        this.pathFinder = pathFinderFactory.create();
+        this.model = new MatrixZoneLayoutModel(Objects.requireNonNull(matrix));
+        for (int row = 0; row < matrix.length; row++) {
+            for (int col = 0; col < matrix[row].length; col++) {
+                String id = matrix[row][col];
+                SubstationGraph sGraph = graph.getSubstationGraph(id);
+                if (sGraph == null && !id.isEmpty()) {
+                    throw new PowsyblException("Substation '" + id + "' was not found in zone graph '" + getGraph().getId() + "'");
+                }
+                model.addSubstationGraph(sGraph, row, col);
+            }
+        }
+    }
+
+    /**
+     * Calculate relative coordinate of substations in the zone
+     */
+    @Override
+    protected void calculateCoordSubstations(LayoutParameters layoutParameters) {
+        Matrix matrix = model.getMatrix();
+        // Display substations on not empty Matrix cell
+        matrix.stream().filter(c -> !c.isEmpty()).map(MatrixCell::graph).forEach(graph -> layoutBySubstation.get(graph).run(layoutParameters));
+        // Height by rows
+        int maxHeightRow = 0;
+        // Width by col
+        int maxWidthCol = 0;
+        // Snakeline hallway (horizontal & vertical)
+        int snakelineMargin = (int) layoutParameters.getZoneLayoutSnakeLinePadding();
+        // Zone size
+        int nbRows = matrix.rowCount();
+        int nbCols = matrix.columnCount();
+        // FIXME : padding diagram is canceled here !
+        double leftPadding = layoutParameters.getDiagramPadding().getLeft();
+        double topPadding = layoutParameters.getDiagramPadding().getTop();
+        // Move each substation into its matrix position
+        for (int row = 0; row < nbRows; row++) {
+            maxWidthCol = 0;
+            for (int col = 0; col < nbCols; col++) {
+                MatrixCell cell = matrix.get(row, col);
+                BaseGraph graph = cell.graph();
+                if (graph != null) {
+                    // Compute delta in order to center substations into own matrix cell
+                    int deltaX = (int) (matrix.getMatrixCellWidth(col) % graph.getWidth()) / 2;
+                    int deltaY = (int) (matrix.getMatrixCellHeight(row) % graph.getHeight()) / 2;
+                    double dx = maxWidthCol + (col + 1.0) * snakelineMargin;
+                    double dy = maxHeightRow + (row + 1.0) * snakelineMargin;
+                    move(graph, dx - leftPadding + deltaX, dy - topPadding + deltaY);
+                }
+                maxWidthCol += matrix.getMatrixCellWidth(col);
+            }
+            maxHeightRow += matrix.getMatrixCellHeight(row);
+        }
+        double zoneWidth = maxWidthCol + (nbCols + 1.0) * snakelineMargin;
+        double zoneHeight = maxHeightRow + (nbRows + 1.0) * snakelineMargin;
+        getGraph().setSize(zoneWidth, zoneHeight);
+    }
+
+    @Override
+    protected List<Point> calculatePolylineSnakeLine(LayoutParameters layoutParameters, Pair<Node, Node> nodes,
+                                                     boolean increment) {
+        List<Point> polyline = new ArrayList<>();
+        Node node1 = nodes.getFirst();
+        Node node2 = nodes.getSecond();
+        VoltageLevelGraph vlGraph1 = getGraph().getVoltageLevelGraph(node1);
+        VoltageLevelGraph vlGraph2 = getGraph().getVoltageLevelGraph(node2);
+        SubstationGraph ss1Graph = getGraph().getSubstationGraph(node1).orElse(null);
+        SubstationGraph ss2Graph = getGraph().getSubstationGraph(node2).orElse(null);
+        if (ss1Graph != null && ss2Graph != null &&
+                model.contains(ss1Graph.getId()) && model.contains(ss2Graph.getId())) { // in the same Zone
+            Point p1 = vlGraph1.getShiftedPoint(node1);
+            Point p2 = vlGraph2.getShiftedPoint(node2);
+            Direction dNode1 = getNodeDirection(node1, 1);
+            Direction dNode2 = getNodeDirection(node2, 2);
+            polyline = new ArrayList<>();
+            // Add starting point
+            polyline.add(p1);
+            // Find snakeline path
+            polyline.addAll(model.buildSnakeline(pathFinder, ss1Graph.getId(), p1, dNode1, ss2Graph.getId(), p2, dNode2, layoutParameters.getZoneLayoutSnakeLinePadding()));
+            // Add ending point
+            polyline.add(p2);
+        }
+        return polyline;
+    }
+
+    @Override
+    public void manageSnakeLines(LayoutParameters layoutParameters) {
+        model.computePathFindingGrid(getGraph(), layoutParameters);
+
+        // Draw snakelines between Substations
+        manageSnakeLines(getGraph(), layoutParameters);
+    }
+}

single-line-diagram/single-line-diagram-core/src/main/java/com/powsybl/sld/layout/MatrixZoneLayoutFactory.java

@@ -0,0 +1,33 @@
+/**
+ * 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.sld.layout;
+
+import com.powsybl.sld.layout.pathfinding.*;
+import com.powsybl.sld.model.graphs.*;
+
+import java.util.*;
+
+/**
+ * @author Thomas Adam {@literal <tadam at neverhack.com>}
+ */
+public class MatrixZoneLayoutFactory implements ZoneLayoutFactory {
+
+    public Layout create(ZoneGraph graph, String[][] matrix, ZoneLayoutPathFinderFactory pathFinderFactory, SubstationLayoutFactory sLayoutFactory, VoltageLevelLayoutFactory vLayoutFactory) {
+        return new MatrixZoneLayout(graph, matrix, pathFinderFactory, sLayoutFactory, vLayoutFactory);
+    }
+
+    @Override
+    public Layout create(ZoneGraph graph, SubstationLayoutFactory sLayoutFactory, VoltageLevelLayoutFactory vLayoutFactory) {
+        // By default, work as Horizontal layout
+        List<String> substations = graph.getSubstations().stream().map(SubstationGraph::getId).toList();
+        String[] array = new String[substations.size()];
+        String[][] matrix = new String[1][];
+        matrix[0] = substations.toArray(array);
+        return new MatrixZoneLayout(graph, matrix, DijkstraPathFinder::new, sLayoutFactory, vLayoutFactory);
+    }
+}