com.powsybl.shortcircuit.FeederResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-shortcircuit-api Show documentation

An API to run three-phase short-circuit analysis

There is a newer version: 6.5.0-RC1

Show newest version

/**
 * Copyright (c) 2023, 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.shortcircuit;

import com.powsybl.iidm.network.ThreeSides;
import com.powsybl.iidm.network.TwoSides;

import javax.annotation.Nullable;

/**
 * Interface to describe the contribution of a feeder to the short-circuit current after the analysis.
 *
 * @author Coline Piloquet {@literal }
 */
public interface FeederResult {

    /**
     * The ID of the connectable contributing to the three-phase short-circuit current.
     */
    String getConnectableId();

    /**
     * The side of the equipment where the result applies.
     * Will be {@code null} for equipments other than branches and three windings transformers.
     */
    @Nullable
    ThreeSides getSide();

    /**
     * The side of the equipment with two sides (like branch) where the result applies.
     */
    TwoSides getSideAsTwoSides();

}