Package com.powsybl.iidm.network

Interface Substation

  • All Superinterfaces:
    Container<Substation>, Extendable<Substation>, Identifiable<Substation>
    public interface Substation
extends Container<Substation>
    A substation is a collection of equipments located at a the same geographical site.

    It is composed of several voltage levels.

    A substation is located to one country and belongs to one TSO.

    To create a substation, see SubstationAdder

    Characteristics

    Attribute Type Unit Required Defaut value Description
    Id String - yes - Unique identifier of the substation
    Name String - yes - Human-readable name of the substation
    Country Countrye - no - The country where this substation is located
    Tso String - no - The TSO this substation belongs to
    GeoraphicalTags List of String - no - A list of geographical tags
    Author:
    Geoffroy Jamgotchian
    See Also:
    VoltageLevel, Country, SubstationAdder

    • Method Detail

      • getCountry

        Optional<Country> getCountry()
        Get an optional containing the country to which the substation belongs if it is defined, Optional.empty() if not.

      • getNullableCountry

        Country getNullableCountry()
        Get country to which the substation belongs if it is defined, null otherwise.
        Returns:
        the country to which the substation belongs if it is defined, null otherwise.

      • getTso

        String getTso()
        Get the TSO to which the substation belongs.

      • newVoltageLevel

        VoltageLevelAdder newVoltageLevel()
        Get a builder to create a new voltage level in the substation.

      • getVoltageLevels

        Iterable<VoltageLevel> getVoltageLevels()
        Get the voltage levels of the substation.

      • getVoltageLevelStream

        Stream<VoltageLevel> getVoltageLevelStream()
        Get the voltage levels of the substation.

      • newTwoWindingsTransformer

        TwoWindingsTransformerAdder newTwoWindingsTransformer()
        Get a builder to create a new two windings transformer in the substation.

      • getTwoWindingsTransformers

        Iterable<TwoWindingsTransformer> getTwoWindingsTransformers()
        Get the two windings transformers connected to the substation.

      • getTwoWindingsTransformerStream

        Stream<TwoWindingsTransformer> getTwoWindingsTransformerStream()
        Get the two windings transformers connected to the substation.

      • getTwoWindingsTransformerCount

        int getTwoWindingsTransformerCount()
        Get the two windings transformers count

      • newThreeWindingsTransformer

        ThreeWindingsTransformerAdder newThreeWindingsTransformer()
        Get a builder to create a new 3 windings transformer in the substation.

      • getThreeWindingsTransformerStream

        Stream<ThreeWindingsTransformer> getThreeWindingsTransformerStream()
        Get the 3 windings transformers connected to the substation.

      • getThreeWindingsTransformerCount

        int getThreeWindingsTransformerCount()
        Get the three windings transformers count

      • getGeographicalTags

        Set<String> getGeographicalTags()
        Get geographical tags associated to the substation.

      • addGeographicalTag

        Substation addGeographicalTag​(String tag)
        Associate a new geographical tag to the substation.

      • remove

        default void remove()
        Remove this substation from the network.