com.powsybl.iidm.modification.topology.CreateFeederBay Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powsybl-iidm-modification Show documentation
The network modification API and a set of classes implementing it
There is a newer version: 6.5.0-RC1
Show newest version
/**
 * Copyright (c) 2022, 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.modification.topology;

import com.powsybl.iidm.network.*;
import com.powsybl.iidm.network.extensions.ConnectablePosition;
import com.powsybl.iidm.network.extensions.ConnectablePositionAdder;

import java.util.Objects;
import java.util.Optional;

/**
 * This method adds a new injection bay on an existing busbar section. The voltage level containing the
 * busbar section should be described in node/breaker topology. The injection is created and connected to
 * the busbar section with a breaker and a closed disconnector. The injection is also connected to all
 * the parallel busbar sections, if any, with an open disconnector.
 *
 * @author Coline Piloquet {@literal }
 */
public class CreateFeederBay extends AbstractCreateConnectableFeederBays {

    private final InjectionAdder injectionAdder;
    private final String busOrBbsId;
    private final Integer injectionPositionOrder;
    private final String injectionFeederName;
    private final ConnectablePosition.Direction injectionDirection;

    /**
     * @param injectionAdder         The injection adder.
     * @param busOrBbsId                  The ID of the existing busbar section where we want to connect the injection.
     *                               Please note that there will be switches between this busbar section and the connection point of the injection. This switch will be closed.
     * @param injectionPositionOrder The order of the injection to be attached from its extension {@link ConnectablePosition}.
     * @param injectionFeederName    The name of the feeder indicated in the extension {@link ConnectablePosition}.
     * @param injectionDirection     The direction of the injection to be attached from its extension {@link ConnectablePosition}.
     */
    CreateFeederBay(InjectionAdder injectionAdder, String busOrBbsId, Integer injectionPositionOrder,
                    String injectionFeederName, ConnectablePosition.Direction injectionDirection) {
        super(0);
        this.injectionAdder = Objects.requireNonNull(injectionAdder);
        this.busOrBbsId = Objects.requireNonNull(busOrBbsId);
        this.injectionPositionOrder = injectionPositionOrder;
        this.injectionFeederName = injectionFeederName;
        this.injectionDirection = Objects.requireNonNull(injectionDirection);
    }

    @Override
    public String getName() {
        return "CreateFeederBay";
    }

    @Override
    protected String getBusOrBusbarSectionId(int side) {
        return busOrBbsId;
    }

    @Override
    protected void setBus(int side, Bus bus, String voltageLevelId) {
        injectionAdder.setConnectableBus(bus.getId()).setBus(bus.getId());
    }

    @Override
    protected void setNode(int side, int node, String voltageLevelId) {
        injectionAdder.setNode(node);
    }

    protected Connectable add() {
        return injectionAdder.add();
    }

    @Override
    protected VoltageLevel getVoltageLevel(int side, Connectable connectable) {
        return ((Injection) connectable).getTerminal().getVoltageLevel();
    }

    @Override
    protected Integer getPositionOrder(int side) {
        return injectionPositionOrder;
    }

    @Override
    protected Optional getFeederName(int side) {
        return Optional.ofNullable(injectionFeederName);
    }

    @Override
    protected ConnectablePosition.Direction getDirection(int side) {
        return injectionDirection;
    }

    @Override
    protected int getNode(int side, Connectable connectable) {
        return ((Injection) connectable).getTerminal().getNodeBreakerView().getNode();
    }

    @Override
    protected ConnectablePositionAdder.FeederAdder getFeederAdder(int side, ConnectablePositionAdder connectablePositionAdder) {
        return connectablePositionAdder.newFeeder();
    }
}