Package com.powsybl.iidm.network
Interface GeneratorAdder
- All Superinterfaces:
IdentifiableAdder<Generator,
,GeneratorAdder> InjectionAdder<Generator,
GeneratorAdder>
To create a generator, from a
VoltageLevel
instance call
the VoltageLevel.newGenerator()
method to get a generator builder
instance.
Example:
VoltageLevel vl = ... Generator g = vl.newGenerator() .setId("g1") ... .add();
- Author:
- Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionadd()
Build the Generator object.setEnergySource
(EnergySource energySource) setMaxP
(double maxP) setMinP
(double minP) setRatedS
(double ratedS) setRegulatingTerminal
(Terminal regulatingTerminal) Set the regulating terminal, If not set or set to null local terminal is used.setTargetP
(double targetP) setTargetQ
(double targetQ) setTargetV
(double targetV) setVoltageRegulatorOn
(boolean voltageRegulatorOn) Methods inherited from interface com.powsybl.iidm.network.IdentifiableAdder
setEnsureIdUnicity, setFictitious, setId, setName
Methods inherited from interface com.powsybl.iidm.network.InjectionAdder
setBus, setConnectableBus, setNode
-
Method Details
-
setEnergySource
-
setMaxP
-
setMinP
-
setVoltageRegulatorOn
-
setRegulatingTerminal
Set the regulating terminal, If not set or set to null local terminal is used. -
setTargetP
-
setTargetQ
-
setTargetV
-
setRatedS
-
add
Generator add()Build the Generator object.
These are the checks that are performed before creating the object :- energySource is set
- minP is not equal to Double.NaN -> minP is set
- maxP is not equal to Double.NaN -> maxP is set
- regulatingTerminal is set
- network of regulatingTerminal's voltageLevel is the network of the generator
- targetP is not equal to Double.NaN -> targetP is set
- targetP is not equal to Double.NaN -> targetP is set
- minP <= maxP
- ratedS is set and ratedS > 0
- Specified by:
add
in interfaceIdentifiableAdder<Generator,
GeneratorAdder> - Specified by:
add
in interfaceInjectionAdder<Generator,
GeneratorAdder> - Returns:
Generator
-