-
- All Superinterfaces:
IdentifiableAdder<Generator,GeneratorAdder>
,InjectionAdder<Generator,GeneratorAdder>
public interface GeneratorAdder extends InjectionAdder<Generator,GeneratorAdder>
To create a generator, from aVoltageLevel
instance call theVoltageLevel.newGenerator()
method to get a generator builder instance.Example:
VoltageLevel vl = ... Generator g = vl.newGenerator() .setId("g1") ... .add();
- Author:
- Geoffroy Jamgotchian
- See Also:
Generator
,VoltageLevel
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Generator
add()
Build the Generator object.GeneratorAdder
setEnergySource(EnergySource energySource)
GeneratorAdder
setMaxP(double maxP)
GeneratorAdder
setMinP(double minP)
GeneratorAdder
setRatedS(double ratedS)
GeneratorAdder
setRegulatingTerminal(Terminal regulatingTerminal)
Set the regulating terminal, If not set or set to null local terminal is used.GeneratorAdder
setTargetP(double targetP)
GeneratorAdder
setTargetQ(double targetQ)
GeneratorAdder
setTargetV(double targetV)
GeneratorAdder
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 Detail
-
setEnergySource
GeneratorAdder setEnergySource(EnergySource energySource)
-
setMaxP
GeneratorAdder setMaxP(double maxP)
-
setMinP
GeneratorAdder setMinP(double minP)
-
setVoltageRegulatorOn
GeneratorAdder setVoltageRegulatorOn(boolean voltageRegulatorOn)
-
setRegulatingTerminal
GeneratorAdder setRegulatingTerminal(Terminal regulatingTerminal)
Set the regulating terminal, If not set or set to null local terminal is used.
-
setTargetP
GeneratorAdder setTargetP(double targetP)
-
setTargetQ
GeneratorAdder setTargetQ(double targetQ)
-
setTargetV
GeneratorAdder setTargetV(double targetV)
-
setRatedS
GeneratorAdder setRatedS(double ratedS)
-
add
Generator add()
Build the Generator object. This 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
-
-