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 equipment 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

See Also:

VoltageLevel, Country, SubstationAdder

Method Summary

Modifier and Type	Method and Description
Substation	addGeographicalTag(java.lang.String tag) Associate a new geographical tag to the substation.
java.util.Optional<Country>	getCountry() Get an optional containing the country to which the substation belongs if it is defined, Optional.empty() if not.
java.util.Set<java.lang.String>	getGeographicalTags() Get geographical tags associated to the substation.
Network	getNetwork()
Country	getNullableCountry() Get country to which the substation belongs if it is defined, null otherwise.
int	getThreeWindingsTransformerCount() Get the three windings transformers count
java.lang.Iterable<ThreeWindingsTransformer>	getThreeWindingsTransformers() Get the 3 windings transformers connected to the substation.
java.util.stream.Stream<ThreeWindingsTransformer>	getThreeWindingsTransformerStream() Get the 3 windings transformers connected to the substation.
java.lang.String	getTso() Get the TSO to which the substation belongs.
int	getTwoWindingsTransformerCount() Get the two windings transformers count
java.lang.Iterable<TwoWindingsTransformer>	getTwoWindingsTransformers() Get the two windings transformers connected to the substation.
java.util.stream.Stream<TwoWindingsTransformer>	getTwoWindingsTransformerStream() Get the two windings transformers connected to the substation.
java.lang.Iterable<VoltageLevel>	getVoltageLevels() Get the voltage levels of the substation.
java.util.stream.Stream<VoltageLevel>	getVoltageLevelStream() Get the voltage levels of the substation.
ThreeWindingsTransformerAdder	newThreeWindingsTransformer() Get a builder to create a new 3 windings transformer in the substation.
TwoWindingsTransformerAdder	newTwoWindingsTransformer() Get a builder to create a new two windings transformer in the substation.
VoltageLevelAdder	newVoltageLevel() Get a builder to create a new voltage level in the substation.
default void	remove() Remove this substation from the network.
Substation	setCountry(Country country)
Substation	setTso(java.lang.String tso)

Methods inherited from interface com.powsybl.iidm.network.Container

getContainerType

Methods inherited from interface com.powsybl.iidm.network.Identifiable

getId, getName, getProperties, hasProperty

Methods inherited from interface com.powsybl.commons.extensions.Extendable

addExtension, getExtension, getExtensionByName, getExtensions, removeExtension

Method Detail

getNetwork

Network getNetwork()

getCountry

java.util.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.

setCountry

Substation setCountry(Country country)

getTso

java.lang.String getTso()

Get the TSO to which the substation belongs.

setTso

Substation setTso(java.lang.String tso)

newVoltageLevel

VoltageLevelAdder newVoltageLevel()

Get a builder to create a new voltage level in the substation.

getVoltageLevels

java.lang.Iterable<VoltageLevel> getVoltageLevels()

Get the voltage levels of the substation.

getVoltageLevelStream

java.util.stream.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

java.lang.Iterable<TwoWindingsTransformer> getTwoWindingsTransformers()

Get the two windings transformers connected to the substation.

getTwoWindingsTransformerStream

java.util.stream.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.

getThreeWindingsTransformers

java.lang.Iterable<ThreeWindingsTransformer> getThreeWindingsTransformers()

Get the 3 windings transformers connected to the substation.

getThreeWindingsTransformerStream

java.util.stream.Stream<ThreeWindingsTransformer> getThreeWindingsTransformerStream()

Get the 3 windings transformers connected to the substation.

getThreeWindingsTransformerCount

int getThreeWindingsTransformerCount()

Get the three windings transformers count

getGeographicalTags

java.util.Set<java.lang.String> getGeographicalTags()

Get geographical tags associated to the substation.

addGeographicalTag

Substation addGeographicalTag(java.lang.String tag)

Associate a new geographical tag to the substation.

remove

default void remove()

Remove this substation from the network.