com.powsybl.iidm.criteria.translation.DefaultNetworkElementAdapter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powsybl-iidm-criteria Show documentation
A utility package containing criteria on IIDM networks
The newest version!
/**
 * Copyright (c) 2024, 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.criteria.translation;

import com.powsybl.iidm.criteria.NetworkElementCriterion.NetworkElementCriterionType;
import com.powsybl.iidm.network.*;

import java.util.List;
import java.util.Optional;

/**
 * Adapter to have a {@link NetworkElement} from an {@link Identifiable} object.
 * @author Sophie Frasnedo {@literal }
 */
public class DefaultNetworkElementAdapter implements NetworkElement {
    private static final List EVERY_SUPPORTED_TYPES = List.of(
            IdentifiableType.LINE,
            IdentifiableType.TIE_LINE,
            IdentifiableType.HVDC_LINE,
            IdentifiableType.TWO_WINDINGS_TRANSFORMER,
            IdentifiableType.THREE_WINDINGS_TRANSFORMER,
            IdentifiableType.DANGLING_LINE,
            IdentifiableType.GENERATOR,
            IdentifiableType.LOAD,
            IdentifiableType.BATTERY,
            IdentifiableType.SHUNT_COMPENSATOR,
            IdentifiableType.STATIC_VAR_COMPENSATOR,
            IdentifiableType.BUSBAR_SECTION,
            IdentifiableType.HVDC_CONVERTER_STATION
    );

    private final Identifiable identifiable;

    public DefaultNetworkElementAdapter(Identifiable identifiable) {
        this.identifiable = identifiable;
    }

    @Override
    public String getId() {
        return identifiable.getId();
    }

    @Override
    public Optional getCountry1() {
        return getCountry(ThreeSides.ONE);
    }

    @Override
    public Optional getCountry2() {
        return getCountry(ThreeSides.TWO);
    }

    @Override
    public Optional getCountry3() {
        return getCountry(ThreeSides.THREE);
    }

    @Override
    public Optional getCountry() {
        return getCountry1();
    }

    @Override
    public Optional getCountry(ThreeSides side) {
        return switch (identifiable.getType()) {
            case LINE, TIE_LINE -> side != ThreeSides.THREE ?
                    getCountryFromTerminal(((Branch) identifiable).getTerminal(side.toTwoSides())) : Optional.empty();
            case HVDC_LINE -> side != ThreeSides.THREE ?
                    getCountryFromTerminal(((HvdcLine) identifiable).getConverterStation(side.toTwoSides()).getTerminal()) : Optional.empty();
            case DANGLING_LINE, GENERATOR, LOAD, BATTERY, SHUNT_COMPENSATOR, STATIC_VAR_COMPENSATOR, BUSBAR_SECTION, HVDC_CONVERTER_STATION ->
                    side != ThreeSides.ONE ? Optional.empty() : getCountryFromTerminal(((Injection) identifiable).getTerminal());
            case TWO_WINDINGS_TRANSFORMER -> ((TwoWindingsTransformer) identifiable).getSubstation().map(Substation::getNullableCountry);
            case THREE_WINDINGS_TRANSFORMER -> ((ThreeWindingsTransformer) identifiable).getSubstation().map(Substation::getNullableCountry);
            default -> Optional.empty();
        };
    }

    private Optional getCountryFromTerminal(Terminal terminal) {
        Optional substation = terminal.getVoltageLevel().getSubstation();
        return substation.map(Substation::getNullableCountry);
    }

    @Override
    public Optional getNominalVoltage1() {
        return getNominalVoltage(ThreeSides.ONE);
    }

    @Override
    public Optional getNominalVoltage2() {
        return getNominalVoltage(ThreeSides.TWO);
    }

    @Override
    public Optional getNominalVoltage3() {
        return getNominalVoltage(ThreeSides.THREE);
    }

    @Override
    public Optional getNominalVoltage() {
        return getNominalVoltage1();
    }

    @Override
    public Optional getNominalVoltage(ThreeSides side) {
        return switch (identifiable.getType()) {
            case DANGLING_LINE, GENERATOR, LOAD, BATTERY, SHUNT_COMPENSATOR, STATIC_VAR_COMPENSATOR, BUSBAR_SECTION, HVDC_CONVERTER_STATION ->
                    side != ThreeSides.ONE ? Optional.empty() :
                            Optional.of(((Injection) identifiable).getTerminal().getVoltageLevel().getNominalV());
            case LINE, TIE_LINE, TWO_WINDINGS_TRANSFORMER ->
                    side == ThreeSides.THREE ? Optional.empty() :
                            Optional.of(((Branch) identifiable).getTerminal(side.toTwoSides()).getVoltageLevel().getNominalV());
            case HVDC_LINE ->
                    side == ThreeSides.THREE ? Optional.empty() :
                            Optional.of(((HvdcLine) identifiable).getConverterStation(side.toTwoSides()).getTerminal().getVoltageLevel().getNominalV());
            case THREE_WINDINGS_TRANSFORMER ->
                    Optional.of(((ThreeWindingsTransformer) identifiable).getTerminal(side).getVoltageLevel().getNominalV());
            default -> Optional.empty();
        };
    }

    @Override
    public boolean isValidFor(NetworkElementCriterionType type) {
        return type == NetworkElementCriterionType.IDENTIFIER
                || type == NetworkElementCriterionType.LINE
                    && identifiable.getType() == IdentifiableType.LINE
                || type == NetworkElementCriterionType.TIE_LINE
                    && identifiable.getType() == IdentifiableType.TIE_LINE
                || type == NetworkElementCriterionType.DANGLING_LINE
                    && identifiable.getType() == IdentifiableType.DANGLING_LINE
                || type == NetworkElementCriterionType.TWO_WINDINGS_TRANSFORMER
                    && identifiable.getType() == IdentifiableType.TWO_WINDINGS_TRANSFORMER
                || type == NetworkElementCriterionType.THREE_WINDINGS_TRANSFORMER
                    && identifiable.getType() == IdentifiableType.THREE_WINDINGS_TRANSFORMER
                || type == NetworkElementCriterionType.IDENTIFIABLE
                    && EVERY_SUPPORTED_TYPES.contains(identifiable.getType());
    }

    public Identifiable getIdentifiable() {
        return identifiable;
    }
}