Package com.powsybl.iidm.modification.topology

Class ConnectVoltageLevelOnLine

java.lang.Object

com.powsybl.iidm.modification.AbstractNetworkModification

com.powsybl.iidm.modification.topology.ConnectVoltageLevelOnLine

All Implemented Interfaces:

NetworkModification

public class ConnectVoltageLevelOnLine
extends AbstractNetworkModification

This method cuts an existing line in two lines that will be created and connected to an existing voltage level (also called switching voltage level). The voltage level should be added to the network just before calling this method, and should contains at least a configured bus in bus/breaker topology or a bus bar section in node/breaker topology.

Author:

Miora Vedelago

Constructor Summary

Constructors

Constructor	Description
ConnectVoltageLevelOnLine(double percent, String voltageLevelId, String bbsOrBusId, String line1Id, String line1Name, String line2Id, String line2Name, Line line)	Constructor.
ConnectVoltageLevelOnLine(String voltageLevelId, String bbsOrBusId, Line line)	Deprecated. Use ConnectVoltageLevelOnLineBuilder instead.
ConnectVoltageLevelOnLine(String voltageLevelId, String bbsOrBusId, String line1Id, String line2Id, Line line)	Deprecated. Use ConnectVoltageLevelOnLineBuilder instead.

Method Summary

Modifier and Type	Method	Description
void	apply(Network network, boolean throwException, ComputationManager computationManager, Reporter reporter)	Applies the modification to the given network.
String	getBbsOrBusId()
Line	getLine()
String	getLine1Id()
String	getLine1Name()
String	getLine2Id()
String	getLine2Name()
double	getPercent()
String	getVoltageLevelId()
ConnectVoltageLevelOnLine	setLine1Id(String line1Id)
ConnectVoltageLevelOnLine	setLine1Name(String line1Name)
ConnectVoltageLevelOnLine	setLine2Id(String line2Id)
ConnectVoltageLevelOnLine	setLine2Name(String line2Name)
ConnectVoltageLevelOnLine	setPercent(double percent)

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

apply, apply, apply, apply, apply

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectVoltageLevelOnLine

@Deprecated(since="4.10.0")
public ConnectVoltageLevelOnLine(String voltageLevelId,
                                 String bbsOrBusId,
                                 Line line)

Deprecated.

Use ConnectVoltageLevelOnLineBuilder instead.

Constructor.

line1Id is line.getId() + "_1".
line2Id is line.getId() + "_2".

ConnectVoltageLevelOnLine

@Deprecated(since="4.10.0")
public ConnectVoltageLevelOnLine(String voltageLevelId,
                                 String bbsOrBusId,
                                 String line1Id,
                                 String line2Id,
                                 Line line)

Deprecated.

Use ConnectVoltageLevelOnLineBuilder instead.

Constructor.

percent is 50.
line1Name is null.
line2Name is null.

ConnectVoltageLevelOnLine

public ConnectVoltageLevelOnLine(double percent,
                                 String voltageLevelId,
                                 String bbsOrBusId,
                                 String line1Id,
                                 String line1Name,
                                 String line2Id,
                                 String line2Name,
                                 Line line)

Constructor.

Parameters:

percent - When the existing line is cut, percent is equal to the ratio between the parameters of the first line and the parameters of the line that is cut multiplied by 100. 100 minus percent is equal to the ratio between the parameters of the second line and the parameters of the line that is cut multiplied by 100.

voltageLevelId - ID of the existing voltage level to be attached on the existing line.

bbsOrBusId - The ID of the configured bus or bus bar section to which the lines will be linked to at the attachment point.

line1Id - The non-null ID of the line segment at side 1.

line1Name - The name of the line segment at side 1.

line2Id - The non-null ID of the line segment at side 2.

line2Name - The name of the line segment at side 2.

line - The line on which the voltage level is to be attached. NB: This constructor will eventually be package-private, please use CreateLineOnLineBuilder instead.

Method Detail

setPercent

public ConnectVoltageLevelOnLine setPercent(double percent)

setLine1Id

public ConnectVoltageLevelOnLine setLine1Id(String line1Id)

setLine1Name

public ConnectVoltageLevelOnLine setLine1Name(String line1Name)

setLine2Id

public ConnectVoltageLevelOnLine setLine2Id(String line2Id)

setLine2Name

public ConnectVoltageLevelOnLine setLine2Name(String line2Name)

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.

getVoltageLevelId

public String getVoltageLevelId()

getBbsOrBusId

public String getBbsOrBusId()

getLine

public Line getLine()

getPercent

public double getPercent()

getLine1Id

public String getLine1Id()

getLine1Name

public String getLine1Name()

getLine2Id

public String getLine2Id()

getLine2Name

public String getLine2Name()