Package com.powsybl.iidm.modification

Class ShuntCompensatorModification

java.lang.Object

com.powsybl.iidm.modification.AbstractNetworkModification

com.powsybl.iidm.modification.ShuntCompensatorModification

All Implemented Interfaces:

NetworkModification

public class ShuntCompensatorModification
extends AbstractNetworkModification

Simple NetworkModification to (dis)connect a shunt compensator and/or change its section.

Author:

Nicolas PIERRE

Constructor Summary

Constructors

Constructor	Description
ShuntCompensatorModification(String shuntCompensatorId, Boolean connect, Integer sectionCount)

Method Summary

Modifier and Type	Method	Description
void	apply(Network network, boolean throwException, ComputationManager computationManager, Reporter reporter)	Applies the modification to the given network.
Boolean	getConnect()
Integer	getSectionCount()
String	getShuntCompensatorId()

Methods inherited from class com.powsybl.iidm.modification.AbstractNetworkModification

apply, apply, apply, apply, apply, logOrThrow

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShuntCompensatorModification

public ShuntCompensatorModification(String shuntCompensatorId,
                                    Boolean connect,
                                    Integer sectionCount)

Method Detail

apply

public void apply(Network network,
                  boolean throwException,
                  ComputationManager computationManager,
                  Reporter reporter)

Description copied from interface: NetworkModification

Applies the modification to the given network. If throwException is set to true, then in case of error, an exception will be thrown. Otherwise, computation will continue but the injection will not be added to the network in case of error.

getConnect

public Boolean getConnect()

getSectionCount

public Integer getSectionCount()

getShuntCompensatorId

public String getShuntCompensatorId()