Package com.powsybl.iidm.network

Interface ShuntCompensatorAdder

All Superinterfaces:

IdentifiableAdder<ShuntCompensatorAdder>, InjectionAdder<ShuntCompensatorAdder>

All Known Implementing Classes:

ShuntCompensatorAdderAdapter

public interface ShuntCompensatorAdder
extends InjectionAdder<ShuntCompensatorAdder>

To create a shunt compensator, from a VoltageLevel instance call the VoltageLevel.newShuntCompensator() method to get a shunt compensator builder instance.

Example:

    VoltageLevel vl = ...
    ShuntCompensator s = vl.newShunt()
            .setId("s1")
            ...
        .add();

Author:

Geoffroy Jamgotchian

See Also:

ShuntCompensator, VoltageLevel

Method Summary

Modifier and Type	Method	Description
ShuntCompensator	add()
ShuntCompensatorLinearModelAdder	newLinearModel()
ShuntCompensatorNonLinearModelAdder	newNonLinearModel()
default ShuntCompensatorAdder	setRegulatingTerminal(Terminal regulatingTerminal)
ShuntCompensatorAdder	setSectionCount(int sectionCount)
default ShuntCompensatorAdder	setTargetDeadband(double targetDeadband)
default ShuntCompensatorAdder	setTargetV(double targetV)
default ShuntCompensatorAdder	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

newLinearModel

ShuntCompensatorLinearModelAdder newLinearModel()

newNonLinearModel

ShuntCompensatorNonLinearModelAdder newNonLinearModel()

setSectionCount

ShuntCompensatorAdder setSectionCount(int sectionCount)

setRegulatingTerminal

default ShuntCompensatorAdder setRegulatingTerminal(Terminal regulatingTerminal)

setVoltageRegulatorOn

default ShuntCompensatorAdder setVoltageRegulatorOn(boolean voltageRegulatorOn)

setTargetV

default ShuntCompensatorAdder setTargetV(double targetV)

setTargetDeadband

default ShuntCompensatorAdder setTargetDeadband(double targetDeadband)

add

ShuntCompensator add()