Package com.powsybl.iidm.network
Interface BatteryAdder
-
- All Superinterfaces:
IdentifiableAdder<BatteryAdder>
,InjectionAdder<BatteryAdder>
- All Known Implementing Classes:
BatteryAdderAdapter
,BatteryAdderImpl
public interface BatteryAdder extends InjectionAdder<BatteryAdder>
To create a battery, from aVoltageLevel
instance call theVoltageLevel.newBattery()
method to get a battery builder instance.Example:
VoltageLevel vl = ... Battery b = vl.newBattery() .setId("b1") ... .add();
- Author:
- Ghiles Abdellah
- See Also:
Battery
,VoltageLevel
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Battery
add()
Build the Battery object.BatteryAdder
setMaxP(double maxP)
Set the maximal active power in MW.BatteryAdder
setMinP(double minP)
Set the minimal active power in MW.default BatteryAdder
setP0(double p0)
Deprecated.UsesetTargetP(double)
instead.default BatteryAdder
setQ0(double q0)
Deprecated.UsesetTargetQ(double)
instead.BatteryAdder
setTargetP(double targetP)
Set the target active power in MW.BatteryAdder
setTargetQ(double targetQ)
Set the target reactive power in MVar.-
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
-
setP0
@Deprecated(since="4.9.0") default BatteryAdder setP0(double p0)
Deprecated.UsesetTargetP(double)
instead.
-
setTargetP
BatteryAdder setTargetP(double targetP)
Set the target active power in MW.Depends on the working variant.
- See Also:
VariantManager
-
setQ0
@Deprecated(since="4.9.0") default BatteryAdder setQ0(double q0)
Deprecated.UsesetTargetQ(double)
instead.
-
setTargetQ
BatteryAdder setTargetQ(double targetQ)
Set the target reactive power in MVar.Depends on the working variant.
- See Also:
VariantManager
-
setMinP
BatteryAdder setMinP(double minP)
Set the minimal active power in MW.
-
setMaxP
BatteryAdder setMaxP(double maxP)
Set the maximal active power in MW.
-
add
Battery add()
Build the Battery object. This are the checks that are performed before creating the object : - p0 is not equal to Double.NaN -> p0 is set - q0 is not equal to Double.NaN -> q0 is set - minP is not equal to Double.NaN -> minP is set - maxP is not equal to Double.NaN -> maxP is set - minP is less than maxP - minP <= p0 <= maxP- Returns:
Battery
-
-