Package com.powsybl.iidm.network
Interface Switch
-
- All Superinterfaces:
Extendable<Switch>
,Identifiable<Switch>
- All Known Implementing Classes:
SwitchAdapter
public interface Switch extends Identifiable<Switch>
A switch to connect equipments in a substation.- Author:
- Geoffroy Jamgotchian
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SwitchKind
getKind()
Get the kind of switch.default IdentifiableType
getType()
Get identifiable type.VoltageLevel
getVoltageLevel()
Get the parent voltage level.boolean
isOpen()
Get the open status of the switch.boolean
isRetained()
Get the retain status of the switch.void
setOpen(boolean open)
Change the switch status.void
setRetained(boolean retained)
Change the retain status of the switch.-
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, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setProperty
-
-
-
-
Method Detail
-
getVoltageLevel
VoltageLevel getVoltageLevel()
Get the parent voltage level.- Returns:
- the parent voltage level
-
getKind
SwitchKind getKind()
Get the kind of switch.
-
isOpen
boolean isOpen()
Get the open status of the switch.Depends on the working variant.
- See Also:
VariantManager
-
setOpen
void setOpen(boolean open)
Change the switch status.Depends on the working variant.
- Parameters:
open
- the new switch status- See Also:
VariantManager
-
isRetained
boolean isRetained()
Get the retain status of the switch. A retained switch is a switch that will be part of the bus/breaker topology.
-
setRetained
void setRetained(boolean retained)
Change the retain status of the switch. A retained switch is a switch that will be part of the bus/breaker topology.- Parameters:
retained
- the retain status of the switch
-
getType
default IdentifiableType getType()
Description copied from interface:Identifiable
Get identifiable type.- Specified by:
getType
in interfaceIdentifiable<Switch>
- Returns:
- the identifiable type
-
-