Interface AreaAdder

All Superinterfaces:
IdentifiableAdder<Area,AreaAdder>
All Known Implementing Classes:
AreaAdderImpl

public interface AreaAdder extends IdentifiableAdder<Area,AreaAdder>
To create an Area, from a Network instance call the Network.newArea() method to get an Area builder instance.

Example:

    Network n = ...
    Area a = n.newArea()
            .setId("FR")
            ...
        .add();
Author:
Marine Guibert <marine.guibert at artelys.com>, Valentin Mouradian <valentin.mouradian at artelys.com>
See Also:
  • Method Details

    • setAreaType

      AreaAdder setAreaType(String areaType)
      Set the Area type
    • setInterchangeTarget

      AreaAdder setInterchangeTarget(double interchangeTarget)
      Set the target interchange of this area in MW, in load sign convention (negative is export, positive is import).
    • addVoltageLevel

      AreaAdder addVoltageLevel(VoltageLevel voltageLevel)
      add a VoltageLevel to the Area
    • addAreaBoundary

      AreaAdder addAreaBoundary(Terminal terminal, boolean ac)
      add a Terminal as an area boundary
    • addAreaBoundary

      AreaAdder addAreaBoundary(Boundary boundary, boolean ac)
      add a DanglingLine boundary as an area boundary
    • add

      Area add()
      Build the Area object.

      These are the checks that are performed before creating the object :

      • areaType is not null;
      Specified by:
      add in interface IdentifiableAdder<Area,AreaAdder>
      Returns:
      Area