Package com.powsybl.iidm.network
Interface AreaAdder
- All Superinterfaces:
IdentifiableAdder<Area,
AreaAdder>
- All Known Implementing Classes:
AreaAdderImpl
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();
-
Method Summary
Modifier and TypeMethodDescriptionadd()
Build the Area object.addAreaBoundary
(Boundary boundary, boolean ac) add a DanglingLine boundary as an area boundaryaddAreaBoundary
(Terminal terminal, boolean ac) add a Terminal as an area boundaryaddVoltageLevel
(VoltageLevel voltageLevel) add a VoltageLevel to the AreasetAreaType
(String areaType) Set the Area typesetInterchangeTarget
(double interchangeTarget) Set the target interchange of this area in MW, in load sign convention (negative is export, positive is import).Methods inherited from interface com.powsybl.iidm.network.IdentifiableAdder
setEnsureIdUnicity, setFictitious, setId, setName
-
Method Details
-
setAreaType
Set the Area type -
setInterchangeTarget
Set the target interchange of this area in MW, in load sign convention (negative is export, positive is import). -
addVoltageLevel
add a VoltageLevel to the Area -
addAreaBoundary
add a Terminal as an area boundary -
addAreaBoundary
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 interfaceIdentifiableAdder<Area,
AreaAdder> - Returns:
Area
-