Custom connection/disconnection of terminals

iidm/iidm-api/src/main/java/com/powsybl/iidm/network/Terminal.java

@@ -11,6 +11,7 @@
 import com.powsybl.math.graph.TraverseResult;
 
 import java.util.Optional;
+import java.util.function.Predicate;
 
 /**
  * An equipment connection point in a substation topology.
@@ -112,60 +113,73 @@ public static interface BusView {
     Connectable getConnectable();
 
     /**
-     * Get the active power in MW injected at the terminal.
-     * <p>
+     * Get the active power in MW injected at the terminal.<br/>
      * Depends on the working variant.
      * @see VariantManager
      */
     double getP();
 
     /**
-     * Set the active power in MW injected at the terminal.
-     * <p>
+     * Set the active power in MW injected at the terminal.<br/>
      * Depends on the working variant.
      * @see VariantManager
      */
     Terminal setP(double p);
 
     /**
-     * Get the reactive power in MVAR injected at the terminal.
-     * <p>
+     * Get the reactive power in MVAR injected at the terminal.<br/>
      * Depends on the working variant.
      * @see VariantManager
      */
     double getQ();
 
     /**
-     * Set the reactive power in MVAR injected at the terminal.
-     * <p>
+     * Set the reactive power in MVAR injected at the terminal.<br/>
      * Depends on the working variant.
      * @see VariantManager
      */
     Terminal setQ(double q);
 
     /**
-     * Get the current in A at the terminal.
-     * <p>Depends on the working variant.
+     * Get the current in A at the terminal.<br/>
+     * Depends on the working variant.
      * @see VariantManager
      */
     double getI();
 
     /**
-     * Try to connect the terminal.
-     * <p>Depends on the working variant.
+     * Try to connect the terminal.<br/>
+     * Depends on the working variant.
      * @return true if terminal has been connected, false otherwise
      * @see VariantManager
      */
     boolean connect();
 
     /**
-     * Disconnect the terminal.
-     * <p>Depends on the working variant.
+     * Try to connect the terminal.<br/>
+     * Depends on the working variant.
+     * @return true if terminal has been connected, false otherwise
+     * @see VariantManager
+     */
+    boolean connect(Predicate<Switch> isTypeSwitchToOperate);
+
+    /**
+     * Disconnect the terminal.<br/>
+     * Depends on the working variant.
      * @return true if terminal has been disconnected, false otherwise
      * @see VariantManager
      */
     boolean disconnect();
 
+    /**
+     * Disconnect the terminal.<br/>
+     * Depends on the working variant.
+     * @param isSwitchOpenable predicate telling if a switch is considered openable
+     * @return true if terminal has been disconnected, false otherwise
+     * @see VariantManager
+     */
+    boolean disconnect(Predicate<Switch> isSwitchOpenable);
+
     /**
      * Test if the terminal is connected.
      * @return true if the terminal is connected, false otherwise

iidm/iidm-api/src/main/java/com/powsybl/iidm/network/util/SwitchPredicates.java

@@ -0,0 +1,30 @@
+/*
+ * 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.iidm.network.util;
+
+import com.powsybl.iidm.network.Switch;
+import com.powsybl.iidm.network.SwitchKind;
+
+import java.util.Objects;
+import java.util.function.Predicate;
+
+/**
+ * @author Nicolas Rol {@literal <nicolas.rol at rte-france.com>}
+ */
+public final class SwitchPredicates {
+
+    private SwitchPredicates() { }
+
+    public static final Predicate<Switch> IS_NONFICTIONAL_CLOSED_BREAKER = switchObject -> switchObject != null && switchObject.getKind() == SwitchKind.BREAKER && !switchObject.isOpen() && !switchObject.isFictitious();
+    public static final Predicate<Switch> IS_NONFICTIONAL_BREAKER = switchObject -> switchObject != null && switchObject.getKind() == SwitchKind.BREAKER && !switchObject.isFictitious();
+    public static final Predicate<Switch> IS_CLOSED_BREAKER = switchObject -> switchObject != null && switchObject.getKind() == SwitchKind.BREAKER && !switchObject.isOpen();
+    public static final Predicate<Switch> IS_BREAKER_OR_DISCONNECTOR = switchObject -> switchObject != null && (switchObject.getKind() == SwitchKind.BREAKER || switchObject.getKind() == SwitchKind.DISCONNECTOR);
+    public static final Predicate<Switch> IS_OPEN_DISCONNECTOR = switchObject -> switchObject != null && switchObject.getKind() == SwitchKind.DISCONNECTOR && switchObject.isOpen();
+    public static final Predicate<Switch> IS_OPEN = switchObject -> switchObject != null && switchObject.isOpen();
+    public static final Predicate<Switch> IS_NON_NULL = Objects::nonNull;
+}

iidm/iidm-impl/src/main/java/com/powsybl/iidm/network/impl/AbstractTerminal.java

@@ -7,14 +7,14 @@
 package com.powsybl.iidm.network.impl;
 
 import com.powsybl.commons.PowsyblException;
-import com.powsybl.iidm.network.IdentifiableType;
-import com.powsybl.iidm.network.Terminal;
-import com.powsybl.iidm.network.ValidationException;
+import com.powsybl.iidm.network.*;
 import com.powsybl.iidm.network.impl.util.Ref;
+import com.powsybl.iidm.network.util.SwitchPredicates;
 import gnu.trove.list.array.TDoubleArrayList;
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.function.Predicate;
 
 /**
  *
@@ -158,18 +158,42 @@ public double getI() {
 
     @Override
     public boolean connect() {
+        return connect(SwitchPredicates.IS_NONFICTIONAL_BREAKER);
+    }
+
+    /**
+     * Try to connect the terminal.<br/>
+     * Depends on the working variant.
+     * @param isTypeSwitchToOperate Predicate telling if a switch is considered operable. Examples of predicates are available in the class {@link SwitchPredicates}
+     * @return true if terminal has been connected, false otherwise
+     * @see VariantManager
+     */
+    @Override
+    public boolean connect(Predicate<Switch> isTypeSwitchToOperate) {
         if (removed) {
             throw new PowsyblException(UNMODIFIABLE_REMOVED_EQUIPMENT + connectable.id);
         }
-        return voltageLevel.connect(this);
+        return voltageLevel.connect(this, isTypeSwitchToOperate);
     }
 
     @Override
     public boolean disconnect() {
+        return disconnect(SwitchPredicates.IS_CLOSED_BREAKER);
+    }
+
+    /**
+     * Disconnect the terminal.<br/>
+     * Depends on the working variant.
+     * @param isSwitchOpenable Predicate telling if a switch is considered openable. Examples of predicates are available in the class {@link SwitchPredicates}
+     * @return true if terminal has been disconnected, false otherwise
+     * @see VariantManager
+     */
+    @Override
+    public boolean disconnect(Predicate<Switch> isSwitchOpenable) {
         if (removed) {
             throw new PowsyblException(UNMODIFIABLE_REMOVED_EQUIPMENT + connectable.id);
         }
-        return voltageLevel.disconnect(this);
+        return voltageLevel.disconnect(this, isSwitchOpenable);
     }
 
     @Override

iidm/iidm-impl/src/main/java/com/powsybl/iidm/network/impl/BusBreakerVoltageLevel.java

@@ -35,6 +35,7 @@
 import java.security.SecureRandom;
 import java.util.*;
 import java.util.function.Function;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
@@ -926,6 +927,11 @@ public boolean connect(TerminalExt terminal) {
         return true;
     }
 
+    @Override
+    public boolean connect(TerminalExt terminal, Predicate<? super SwitchImpl> isTypeSwitchToOperate) {
+        return connect(terminal);
+    }
+
     @Override
     public boolean disconnect(TerminalExt terminal) {
         if (!(terminal instanceof BusTerminal)) {
@@ -942,7 +948,11 @@ public boolean disconnect(TerminalExt terminal) {
         invalidateCache();
 
         return true;
+    }
 
+    @Override
+    public boolean disconnect(TerminalExt terminal, Predicate<? super SwitchImpl> isSwitchOpenable) {
+        return disconnect(terminal);
     }
 
     void traverse(BusTerminal terminal, Terminal.TopologyTraverser traverser, TraversalType traversalType) {