com.farao_community.farao.data.crac_impl.AngleCnecAdderImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of farao-crac-impl Show documentation
Object model for CRAC implementation
There is a newer version: 5.0.0
/*
 * 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.farao_community.farao.data.crac_impl;

import com.farao_community.farao.commons.FaraoException;
import com.farao_community.farao.commons.Unit;
import com.farao_community.farao.data.crac_api.State;
import com.farao_community.farao.data.crac_api.cnec.AngleCnec;
import com.farao_community.farao.data.crac_api.cnec.AngleCnecAdder;
import com.farao_community.farao.data.crac_api.threshold.AngleThresholdAdder;
import com.farao_community.farao.data.crac_api.threshold.Threshold;

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

import static java.lang.String.format;

/**
 * @author Joris Mancini {@literal }
 */
public class AngleCnecAdderImpl extends AbstractCnecAdderImpl implements AngleCnecAdder {

    private final Set thresholds = new HashSet<>();
    private String exportingNetworkElementId;
    private String importingNetworkElementId;
    private static final String CNEC_TYPE = "AngleCnec";

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

    @Override
    public AngleCnecAdder withNetworkElement(String networkElementId) {
        throw new FaraoException("For an angle cnec, use withExportingNetworkElement() and withImportingNetworkElement().");
    }

    @Override
    public AngleCnecAdder withNetworkElement(String networkElementId, String networkElementName) {
        throw new FaraoException("For an angle cnec, use withExportingNetworkElement() and withImportingNetworkElement().");
    }

    @Override
    public AngleCnecAdder withExportingNetworkElement(String exportingNetworkElementId) {
        this.withExportingNetworkElement(exportingNetworkElementId, exportingNetworkElementId);
        return this;
    }

    @Override
    public AngleCnecAdder withExportingNetworkElement(String exportingNetworkElementId, String exportingNetworkElementName) {
        this.exportingNetworkElementId = exportingNetworkElementId;
        super.withNetworkElement(exportingNetworkElementId, exportingNetworkElementName);
        return this;
    }

    @Override
    public AngleCnecAdder withImportingNetworkElement(String importingNetworkElementId) {
        this.withImportingNetworkElement(importingNetworkElementId, importingNetworkElementId);
        return this;
    }

    @Override
    public AngleCnecAdder withImportingNetworkElement(String importingNetworkElementId, String importingNetworkElementName) {
        this.importingNetworkElementId = importingNetworkElementId;
        super.withNetworkElement(importingNetworkElementId, importingNetworkElementName);
        return this;
    }

    @Override
    public AngleThresholdAdder newThreshold() {
        return new AngleThresholdAdderImpl(this);
    }

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

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

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

        if (optimized) {
            throw new FaraoException(format("Error while adding cnec %s : Farao does not allow the optimization of AngleCnecs.", id));
        }

        checkAndInitThresholds();

        State state = getState();

        AngleCnec cnec = new AngleCnecImpl(id, name,
            owner.getNetworkElement(exportingNetworkElementId),
            owner.getNetworkElement(importingNetworkElementId),
            operator, state, optimized, monitored,
            thresholds, reliabilityMargin);

        owner.addAngleCnec(cnec);
        return cnec;
    }

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

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

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

    @Override
    protected void checkCnec() {
        AdderUtils.assertAttributeNotNull(exportingNetworkElementId, CNEC_TYPE, "exporting network element", "withExportingNetworkElement()");
        AdderUtils.assertAttributeNotNull(importingNetworkElementId, CNEC_TYPE, "importing network element", "withImportingNetworkElement()");
        super.checkCnec();
    }
}