Package com.powsybl.iidm.network
Interface Substation
- All Superinterfaces:
Container<Substation>
,Extendable<Substation>
,Identifiable<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 <geoffroy.jamgotchian at rte-france.com>
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionaddGeographicalTag
(String tag) Associate a new geographical tag to the substation.Get an optional containing the country to which the substation belongs if it is defined, Optional.empty() if not.Get geographical tags associated to the substation.Get country to which the substation belongs if it is defined, null otherwise.int
Get the overload management systems countGet the overload management systems relative to the substation.Get the overload management systems relative to the substation.int
Get the three windings transformers countGet the 3 windings transformers connected to the substation.Get the 3 windings transformers connected to the substation.getTso()
Get the TSO to which the substation belongs.int
Get the two windings transformers countGet the two windings transformers connected to the substation.Get the two windings transformers connected to the substation.default IdentifiableType
getType()
Get identifiable type.Get the voltage levels of the substation.Get the voltage levels of the substation.Get a builder to create a new overload management system in the substation.Get a builder to create a new 3 windings transformer in the substation.Get a builder to create a new two windings transformer in the substation.Get a builder to create a new voltage level in the substation.default void
remove()
Remove this substation from the network.setCountry
(Country country) Methods inherited from interface com.powsybl.iidm.network.Container
getContainerType
Methods inherited from interface com.powsybl.commons.extensions.Extendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
Methods inherited from interface com.powsybl.iidm.network.Identifiable
addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getNameOrId, getNetwork, getOptionalName, getParentNetwork, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setName, setProperty
-
Method Details
-
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
-
getTso
String getTso()Get the TSO to which the substation belongs. -
setTso
-
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. Only use this builder if the two ends of the transformer are in the substation. Else useNetwork#newTwoWindingsTransformer()
. -
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. Only use this builder if the three ends of the transformer are in the substation. Else useNetwork#newThreeWindingsTransformer()
. -
getThreeWindingsTransformers
Iterable<ThreeWindingsTransformer> getThreeWindingsTransformers()Get the 3 windings transformers connected to the substation. -
getThreeWindingsTransformerStream
Stream<ThreeWindingsTransformer> getThreeWindingsTransformerStream()Get the 3 windings transformers connected to the substation. -
getThreeWindingsTransformerCount
int getThreeWindingsTransformerCount()Get the three windings transformers count -
newOverloadManagementSystem
OverloadManagementSystemAdder newOverloadManagementSystem()Get a builder to create a new overload management system in the substation. -
getOverloadManagementSystems
Iterable<OverloadManagementSystem> getOverloadManagementSystems()Get the overload management systems relative to the substation. -
getOverloadManagementSystemStream
Stream<OverloadManagementSystem> getOverloadManagementSystemStream()Get the overload management systems relative to the substation. -
getOverloadManagementSystemCount
int getOverloadManagementSystemCount()Get the overload management systems count -
getGeographicalTags
Get geographical tags associated to the substation. -
addGeographicalTag
Associate a new geographical tag to the substation. -
remove
default void remove()Remove this substation from the network. -
getType
Description copied from interface:Identifiable
Get identifiable type.- Specified by:
getType
in interfaceIdentifiable<Substation>
- Returns:
- the identifiable type
-