Package com.powsybl.iidm.modification.topology

Class CreateVoltageLevelTopologyBuilder

java.lang.Object
com.powsybl.iidm.modification.topology.CreateVoltageLevelTopologyBuilder
public class CreateVoltageLevelTopologyBuilder extends Object
Author:
Miora Vedelago <miora.ralambotiana at rte-france.com>

  • Constructor Details

    • CreateVoltageLevelTopologyBuilder

      public CreateVoltageLevelTopologyBuilder()

  • Method Details

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

    • withLowBusOrBusbarIndex

      public CreateVoltageLevelTopologyBuilder withLowBusOrBusbarIndex(int lowBusOrBusbarIndex)
      Set the lowest index of bus or busbar index that will be created (1 by default).
      Parameters:
      lowBusOrBusbarIndex -

    • withAlignedBusesOrBusbarCount

      public CreateVoltageLevelTopologyBuilder withAlignedBusesOrBusbarCount(int alignedBusesOrBusbarCount)
      Set the number of parallel bus lines or busbar which will be created. In case of node/breaker topology, it is the number of busbar sections. In case of bus/breaker topology, it is the number of lines of aligned buses.
      Parameters:
      alignedBusesOrBusbarCount -

    • 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 or the number of switches between the buses in bus/breaker topology.
      Parameters:
      sectionCount -

    • withBusbarSectionPrefixId

      public CreateVoltageLevelTopologyBuilder withBusbarSectionPrefixId(String busbarSectionPrefixId)
      Set the prefix ID for the created buses or 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 be SwitchKind.BREAKER, SwitchKind.DISCONNECTOR or null. If it is SwitchKind.BREAKER, a closed disconnector, a closed breaker and a closed disconnector are created. If it is SwitchKind.DISCONNECTOR, a closed disconnector is created. If it is null, no switch is created: the sections are disconnected. In bus/breaker topology, all the switching devices are by default breakers.
      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 be SwitchKind.BREAKER, SwitchKind.DISCONNECTOR or null. If it is SwitchKind.BREAKER, a closed disconnector, a closed breaker and a closed disconnector are created. If it is SwitchKind.DISCONNECTOR, a closed disconnector is created. In bus/breaker topology, all the switching devices are by default breakers.
      Parameters:
      switchKinds -

    • build

      public CreateVoltageLevelTopology build()