VoltageCnecAdderImpl.java

/*
 * 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/.
 */

package com.powsybl.openrao.data.crac.impl;

import com.powsybl.openrao.commons.OpenRaoException;
import com.powsybl.openrao.commons.Unit;
import com.powsybl.openrao.data.crac.api.State;
import com.powsybl.openrao.data.crac.api.cnec.VoltageCnec;
import com.powsybl.openrao.data.crac.api.cnec.VoltageCnecAdder;
import com.powsybl.openrao.data.crac.api.threshold.Threshold;
import com.powsybl.openrao.data.crac.api.threshold.VoltageThresholdAdder;

import java.util.HashSet;
import java.util.Set;

import static java.lang.String.format;

/**
 * @author Philippe Edwards {@literal <philippe.edwards at rte-france.com>}
 */
public class VoltageCnecAdderImpl extends AbstractCnecAdderImpl<VoltageCnecAdder> implements VoltageCnecAdder {

    private final Set<Threshold> thresholds = new HashSet<>();
    private static final String CNEC_TYPE = "VoltageCnec";

    VoltageCnecAdderImpl(CracImpl owner) {
        super(owner);
    }

    @Override
    public VoltageCnecAdder withNetworkElement(String networkElementId, String networkElementName) {
        if (!this.networkElementsIdAndName.entrySet().isEmpty()) {
            throw new OpenRaoException("Cannot add multiple network elements for a voltage cnec.");
        }
        super.withNetworkElement(networkElementId, networkElementName);
        return this;
    }

    @Override
    public VoltageThresholdAdder newThreshold() {
        return new VoltageThresholdAdderImpl(this);
    }

    void addThreshold(ThresholdImpl threshold) {
        thresholds.add(threshold);
    }

    @Override
    protected String getTypeDescription() {
        return CNEC_TYPE;
    }

    @Override
    public VoltageCnec add() {
        checkCnec();

        if (optimized) {
            throw new OpenRaoException(format("Error while adding cnec %s : Open RAO does not allow the optimization of VoltageCnecs.", id));
        }

        checkAndInitThresholds();

        State state = getState();

        VoltageCnec cnec = new VoltageCnecImpl(id, name,
            owner.getNetworkElement(networkElementsIdAndName.keySet().iterator().next()),
            operator, border, state, optimized, monitored,
            thresholds, reliabilityMargin);

        owner.addVoltageCnec(cnec);
        return cnec;
    }

    private void checkAndInitThresholds() {
        /*
         This should be done here, and not in Threshold Adder, as some information of the VoltageCnec is required
         to perform those checks
         */

        if (this.thresholds.isEmpty()) {
            throw new OpenRaoException("Cannot add an VoltageCnec without a threshold. Please use newThreshold");
        }

        if (this.thresholds.stream().anyMatch(th -> !th.getUnit().equals(Unit.KILOVOLT))) {
            throw new OpenRaoException("VoltageCnec threshold must be in KILOVOLT");
        }
    }
}