Class CreateVoltageLevelTopologyBuilder
- java.lang.Object
-
- com.powsybl.iidm.modification.topology.CreateVoltageLevelTopologyBuilder
-
public class CreateVoltageLevelTopologyBuilder extends Object
- Author:
- Miora Vedelago
-
-
Constructor Summary
Constructors Constructor Description CreateVoltageLevelTopologyBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateVoltageLevelTopology
build()
CreateVoltageLevelTopologyBuilder
withBusbarCount(int busbarCount)
Set the number of busbar which will be created.CreateVoltageLevelTopologyBuilder
withBusbarSectionPrefixId(String busbarSectionPrefixId)
Set the prefix ID for the created busbar sections.CreateVoltageLevelTopologyBuilder
withLowBusbarIndex(int lowBusbarIndex)
Set the lowest index of busbar index that will be created (1 by default).CreateVoltageLevelTopologyBuilder
withLowSectionIndex(int lowSectionIndex)
Set the lowest index of section index that will be created (1 by default).CreateVoltageLevelTopologyBuilder
withSectionCount(int sectionCount)
Set the number of sections for each created busbar.CreateVoltageLevelTopologyBuilder
withSwitchKinds(SwitchKind... switchKinds)
Set the switching devices between the sections of a busbar.CreateVoltageLevelTopologyBuilder
withSwitchKinds(List<SwitchKind> switchKinds)
Set the switching devices between the sections of a busbar.CreateVoltageLevelTopologyBuilder
withSwitchPrefixId(String switchPrefixId)
Set the prefix ID for the created switches.CreateVoltageLevelTopologyBuilder
withVoltageLevelId(String voltageLevelId)
Set the voltage level ID in which the symmetrical topology will be created.
-
-
-
Method Detail
-
withVoltageLevelId
public CreateVoltageLevelTopologyBuilder withVoltageLevelId(String voltageLevelId)
Set the voltage level ID in which the symmetrical topology will be created. If the voltage level does not exist, an exception is thrown or the modification is ignored.- Parameters:
voltageLevelId
-
-
withLowBusbarIndex
public CreateVoltageLevelTopologyBuilder withLowBusbarIndex(int lowBusbarIndex)
Set the lowest index of busbar index that will be created (1 by default).- Parameters:
lowBusbarIndex
-
-
withBusbarCount
public CreateVoltageLevelTopologyBuilder withBusbarCount(int busbarCount)
Set the number of busbar which will be created.- Parameters:
busbarCount
-
-
withLowSectionIndex
public CreateVoltageLevelTopologyBuilder withLowSectionIndex(int lowSectionIndex)
Set the lowest index of section index that will be created (1 by default).- Parameters:
lowSectionIndex
-
-
withSectionCount
public CreateVoltageLevelTopologyBuilder withSectionCount(int sectionCount)
Set the number of sections for each created busbar.- Parameters:
sectionCount
-
-
withBusbarSectionPrefixId
public CreateVoltageLevelTopologyBuilder withBusbarSectionPrefixId(String busbarSectionPrefixId)
Set the prefix ID for the created busbar sections. By default, it is equals to the voltage level ID.- Parameters:
busbarSectionPrefixId
-
-
withSwitchPrefixId
public CreateVoltageLevelTopologyBuilder withSwitchPrefixId(String switchPrefixId)
Set the prefix ID for the created switches. By default, it is equals to the voltage level ID.- Parameters:
switchPrefixId
-
-
withSwitchKinds
public CreateVoltageLevelTopologyBuilder withSwitchKinds(SwitchKind... switchKinds)
Set the switching devices between the sections of a busbar. There are as many specified switch kinds as there are intervals between sections i.e.sectionCount - 1
. The switch kinds can beSwitchKind.BREAKER
,SwitchKind.DISCONNECTOR
or null. If it isSwitchKind.BREAKER
, a closed disconnector, a closed breaker and a closed disconnector are created. If it isSwitchKind.DISCONNECTOR
, a closed disconnector is created. If it is null, no switch is created: the sections are disconnected.- Parameters:
switchKinds
-
-
withSwitchKinds
public CreateVoltageLevelTopologyBuilder withSwitchKinds(List<SwitchKind> switchKinds)
Set the switching devices between the sections of a busbar. There are as many specified switch kinds as there are intervals between sections i.e.sectionCount - 1
. The switch kinds can beSwitchKind.BREAKER
,SwitchKind.DISCONNECTOR
or null. If it isSwitchKind.BREAKER
, a closed disconnector, a closed breaker and a closed disconnector are created. If it isSwitchKind.DISCONNECTOR
, a closed disconnector is created.- Parameters:
switchKinds
-
-
build
public CreateVoltageLevelTopology build()
-
-