com.powsybl.openrao.data.cracimpl.SwitchPairAdderImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of open-rao-crac-impl Show documentation
Object model for CRAC implementation
The newest version!
/*
 * Copyright (c) 2021, 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.openrao.data.cracimpl;

import com.powsybl.openrao.commons.OpenRaoException;
import com.powsybl.openrao.data.cracapi.NetworkElement;
import com.powsybl.openrao.data.cracapi.networkaction.*;

import static com.powsybl.openrao.data.cracimpl.AdderUtils.assertAttributeNotNull;

/**
 * @author Peter Mitri {@literal }
 */
public class SwitchPairAdderImpl implements SwitchPairAdder {

    private final NetworkActionAdderImpl ownerAdder;
    private String switchToOpenId;
    private String switchToOpenName;
    private String switchToCloseId;
    private String switchToCloseName;

    SwitchPairAdderImpl(NetworkActionAdderImpl ownerAdder) {
        this.ownerAdder = ownerAdder;
    }

    @Override
    public SwitchPairAdder withSwitchToOpen(String networkElementId) {
        return withSwitchToOpen(networkElementId, networkElementId);
    }

    @Override
    public SwitchPairAdder withSwitchToClose(String networkElementId) {
        return withSwitchToClose(networkElementId, networkElementId);
    }

    @Override
    public SwitchPairAdder withSwitchToOpen(String networkElementId, String networkElementName) {
        this.switchToOpenId = networkElementId;
        this.switchToOpenName = networkElementName;
        return this;
    }

    @Override
    public SwitchPairAdder withSwitchToClose(String networkElementId, String networkElementName) {
        this.switchToCloseId = networkElementId;
        this.switchToCloseName = networkElementName;
        return this;
    }

    @Override
    public NetworkActionAdder add() {
        assertAttributeNotNull(switchToOpenId, getActionName(), "switch to open", "withSwitchToOpen()");
        assertAttributeNotNull(switchToCloseId, getActionName(), "switch to close", "withSwitchToClose()");
        if (switchToOpenId.equals(switchToCloseId)) {
            throw new OpenRaoException("A switch pair cannot be created with the same switch to open & close!");
        }
        NetworkElement switchToOpen = this.ownerAdder.getCrac().addNetworkElement(switchToOpenId, switchToOpenName);
        NetworkElement switchToClose = this.ownerAdder.getCrac().addNetworkElement(switchToCloseId, switchToCloseName);
        String id = String.format("%s_%s_%s", getActionName(), switchToOpen.getId(), switchToClose.getId());
        ownerAdder.addElementaryAction(new SwitchPairImpl(id, switchToOpen, switchToClose), switchToOpen, switchToClose);
        return ownerAdder;
    }

    protected String getActionName() {
        return "SwitchPair";
    }
}