Package com.powsybl.iidm.network

Interface Branch<I extends Branch<I>>

All Superinterfaces:

Extendable<I>, Identifiable<I>

All Known Subinterfaces:

Line, TieLine, TwoWindingsTransformer

public interface Branch<I extends Branch<I>>
extends Identifiable<I>

An equipment with two terminals.

Characteristics

Attribute	Type	Unit	Required	Defaut value	Description
Id	String	-	yes	-	Unique identifier of the branch
Name	String	-	yes	-	Human-readable name of the branch
R	double	Ω	yes	-	The series resistance
X	double	Ω	yes	-	The series reactance
G1	double	S	yes	-	The first side shunt conductance
B1	double	S	yes	-	The first side shunt susceptance
G2	double	S	yes	-	The second side shunt conductance
B2	double	S	yes	-	The second side shunt susceptance

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Method Summary

Modifier and Type	Method	Description
void	cancelSelectedOperationalLimitsGroup1()	Cancel the selected OperationalLimitsGroup on side 1.
void	cancelSelectedOperationalLimitsGroup2()	Cancel the selected OperationalLimitsGroup on side 2.
boolean	checkPermanentLimit(TwoSides side, double limitReductionValue, LimitType type)
boolean	checkPermanentLimit(TwoSides side, LimitType type)
boolean	checkPermanentLimit1(double limitReductionValue, LimitType type)
boolean	checkPermanentLimit1(LimitType type)
boolean	checkPermanentLimit2(double limitReductionValue, LimitType type)
boolean	checkPermanentLimit2(LimitType type)
Overload	checkTemporaryLimits(TwoSides side, double limitReductionValue, LimitType type)
Overload	checkTemporaryLimits(TwoSides side, LimitType type)
Overload	checkTemporaryLimits1(double limitReductionValue, LimitType type)
Overload	checkTemporaryLimits1(LimitType type)
Overload	checkTemporaryLimits2(double limitReductionValue, LimitType type)
Overload	checkTemporaryLimits2(LimitType type)
default Optional<ActivePowerLimits>	getActivePowerLimits(TwoSides side)
default Optional<ActivePowerLimits>	getActivePowerLimits1()	Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 1.
default Optional<ActivePowerLimits>	getActivePowerLimits2()	Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 2.
default Optional<ApparentPowerLimits>	getApparentPowerLimits(TwoSides side)
default Optional<ApparentPowerLimits>	getApparentPowerLimits1()	Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 1.
default Optional<ApparentPowerLimits>	getApparentPowerLimits2()	Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 2.
default Optional<CurrentLimits>	getCurrentLimits(TwoSides side)
default Optional<CurrentLimits>	getCurrentLimits1()	Get the CurrentLimits of the selected OperationalLimitsGroup on side 1.
default Optional<CurrentLimits>	getCurrentLimits2()	Get the CurrentLimits of the selected OperationalLimitsGroup on side 2.
default Optional<? extends LoadingLimits>	getLimits(LimitType type, TwoSides side)
default ActivePowerLimits	getNullableActivePowerLimits(TwoSides side)
default ActivePowerLimits	getNullableActivePowerLimits1()	Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 1.
default ActivePowerLimits	getNullableActivePowerLimits2()	Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 2.
default ApparentPowerLimits	getNullableApparentPowerLimits(TwoSides side)
default ApparentPowerLimits	getNullableApparentPowerLimits1()	Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 1.
default ApparentPowerLimits	getNullableApparentPowerLimits2()	Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 2.
default CurrentLimits	getNullableCurrentLimits(TwoSides side)
default CurrentLimits	getNullableCurrentLimits1()	Get the CurrentLimits of the selected OperationalLimitsGroup on side 1.
default CurrentLimits	getNullableCurrentLimits2()	Get the CurrentLimits of the selected OperationalLimitsGroup on side 2.
default LoadingLimits	getNullableLimits(LimitType type, TwoSides side)
Optional<OperationalLimitsGroup>	getOperationalLimitsGroup1(String id)	Get the OperationalLimitsGroup corresponding to an ID on side 1.
Optional<OperationalLimitsGroup>	getOperationalLimitsGroup2(String id)	Get the OperationalLimitsGroup corresponding to an ID on side 2.
Collection<OperationalLimitsGroup>	getOperationalLimitsGroups1()	Get the collection of the defined OperationalLimitsGroup on side 1.
Collection<OperationalLimitsGroup>	getOperationalLimitsGroups2()	Get the collection of the defined OperationalLimitsGroup on side 2.
int	getOverloadDuration()
Optional<OperationalLimitsGroup>	getSelectedOperationalLimitsGroup1()	Get the selected OperationalLimitsGroup on side 1.
Optional<OperationalLimitsGroup>	getSelectedOperationalLimitsGroup2()	Get the selected OperationalLimitsGroup on side 2.
Optional<String>	getSelectedOperationalLimitsGroupId1()	Get the OperationalLimitsGroup corresponding to an ID on side 1.
Optional<String>	getSelectedOperationalLimitsGroupId2()	Get the OperationalLimitsGroup corresponding to an ID on side 2.
TwoSides	getSide(Terminal terminal)
Terminal	getTerminal(TwoSides side)
Terminal	getTerminal(String voltageLevelId)
Terminal	getTerminal1()	Get the first terminal.
Terminal	getTerminal2()	Get the second terminal.
boolean	isOverloaded()	Only checks overloading for LimitType.Current and permanent limits
boolean	isOverloaded(double limitReductionValue)	Only checks overloading for LimitType.Current and permanent limits
ActivePowerLimitsAdder	newActivePowerLimits1()	Create an adder to add a new ActivePowerLimits in the selected OperationalLimitsGroup on side 1.
ActivePowerLimitsAdder	newActivePowerLimits2()	Create an adder to add a new ActivePowerLimits in the selected OperationalLimitsGroup on side 2.
ApparentPowerLimitsAdder	newApparentPowerLimits1()	Create an adder to add a new ApparentPowerLimits in the selected OperationalLimitsGroup on side 1.
ApparentPowerLimitsAdder	newApparentPowerLimits2()	Create an adder to add a new ApparentPowerLimits in the selected OperationalLimitsGroup on side 2.
CurrentLimitsAdder	newCurrentLimits1()	Create an adder to add a new CurrentLimits in the selected OperationalLimitsGroup on side 1.
CurrentLimitsAdder	newCurrentLimits2()	Create an adder to add a new CurrentLimits in the selected OperationalLimitsGroup on side 2.
OperationalLimitsGroup	newOperationalLimitsGroup1(String id)	Create a new OperationalLimitsGroup on side 1 with the given ID.
OperationalLimitsGroup	newOperationalLimitsGroup2(String id)	Create a new OperationalLimitsGroup on side 2 with the given ID.
void	removeOperationalLimitsGroup1(String id)	Remove the OperationalLimitsGroup corresponding to the given ID on side 1.
void	removeOperationalLimitsGroup2(String id)	Remove the OperationalLimitsGroup corresponding to the given ID on side 2.
void	setSelectedOperationalLimitsGroup1(String id)	Set the OperationalLimitsGroup corresponding to the given ID as as the selected one on side 1.
void	setSelectedOperationalLimitsGroup2(String id)	Set the OperationalLimitsGroup corresponding to the given ID as as the selected one on side 2.

Methods inherited from interface com.powsybl.commons.extensions.Extendable

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension

Methods inherited from interface com.powsybl.iidm.network.Identifiable

addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getNameOrId, getNetwork, getOptionalName, getParentNetwork, getProperty, getProperty, getPropertyNames, getType, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setName, setProperty

Method Details

getTerminal1

Terminal getTerminal1()

Get the first terminal.

getTerminal2

Terminal getTerminal2()

Get the second terminal.

getTerminal

Terminal getTerminal(TwoSides side)

getTerminal

Terminal getTerminal(String voltageLevelId)

getSide

TwoSides getSide(Terminal terminal)

getOperationalLimitsGroups1

Collection<OperationalLimitsGroup> getOperationalLimitsGroups1()

Get the collection of the defined OperationalLimitsGroup on side 1.

Returns:

the OperationalLimitsGroup s on side 1.

getSelectedOperationalLimitsGroupId1

Optional<String> getSelectedOperationalLimitsGroupId1()

Get the OperationalLimitsGroup corresponding to an ID on side 1.

Returns:

the OperationalLimitsGroup of the given ID on side 1 if any, an empty Optional otherwise.

getOperationalLimitsGroup1

Optional<OperationalLimitsGroup> getOperationalLimitsGroup1(String id)

Get the OperationalLimitsGroup corresponding to an ID on side 1.

Returns:

the OperationalLimitsGroup of the given ID on side 1 if any, an empty Optional otherwise.

getSelectedOperationalLimitsGroup1

Optional<OperationalLimitsGroup> getSelectedOperationalLimitsGroup1()

Get the selected OperationalLimitsGroup on side 1.

Returns:

the selected OperationalLimitsGroup on side 1 if any, an empty Optional otherwise.

newOperationalLimitsGroup1

OperationalLimitsGroup newOperationalLimitsGroup1(String id)

Create a new OperationalLimitsGroup on side 1 with the given ID.

If a group of the given ID already exists, it is replaced silently.

Returns:

the newly created group OperationalLimitsGroup.

setSelectedOperationalLimitsGroup1

void setSelectedOperationalLimitsGroup1(String id)

Set the OperationalLimitsGroup corresponding to the given ID as as the selected one on side 1.

Throw a PowsyblException if the ID doesn't correspond to any existing group.

Throw an NullPointerException if the ID is null. To reset the selected group, use cancelSelectedOperationalLimitsGroup1().

Parameters:

id - an ID of OperationalLimitsGroup

removeOperationalLimitsGroup1

void removeOperationalLimitsGroup1(String id)

Remove the OperationalLimitsGroup corresponding to the given ID on side 1.

Throw an NullPointerException if the ID is null.

Parameters:

id - an ID of OperationalLimitsGroup

cancelSelectedOperationalLimitsGroup1

void cancelSelectedOperationalLimitsGroup1()

Cancel the selected OperationalLimitsGroup on side 1.

After calling this method, no OperationalLimitsGroup is selected on side 1.

getCurrentLimits1

default Optional<CurrentLimits> getCurrentLimits1()

Get the CurrentLimits of the selected OperationalLimitsGroup on side 1.

Returns:

CurrentLimits of the selected OperationalLimitsGroup on side 1 if any, null otherwise.

getNullableCurrentLimits1

default CurrentLimits getNullableCurrentLimits1()

Get the CurrentLimits of the selected OperationalLimitsGroup on side 1.

Returns:

CurrentLimits of the selected OperationalLimitsGroup on side 1 if any, null otherwise.

getActivePowerLimits1

default Optional<ActivePowerLimits> getActivePowerLimits1()

Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 1.

Returns:

ActivePowerLimits of the selected OperationalLimitsGroup on side 1 if any, an empty Optional otherwise.

getNullableActivePowerLimits1

default ActivePowerLimits getNullableActivePowerLimits1()

Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 1.

Returns:

ActivePowerLimits of the selected OperationalLimitsGroup on side 1 if any, null otherwise.

getApparentPowerLimits1

default Optional<ApparentPowerLimits> getApparentPowerLimits1()

Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 1.

Returns:

ApparentPowerLimits of the selected OperationalLimitsGroup on side 1 if any, an empty Optional otherwise.

getNullableApparentPowerLimits1

default ApparentPowerLimits getNullableApparentPowerLimits1()

Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 1.

Returns:

ApparentPowerLimits of the selected OperationalLimitsGroup on side 1 if any, null otherwise.

newCurrentLimits1

CurrentLimitsAdder newCurrentLimits1()

Create an adder to add a new CurrentLimits in the selected OperationalLimitsGroup on side 1.

If there's no selected group, the adder will also create a new group with the default name and set it as selected. This operation is performed when the limits are created via OperationalLimitsAdder.add(), only if the limits to add are valid.

Returns:

an adder allowing to create a new CurrentLimits in the selected OperationalLimitsGroup on side 1.

newActivePowerLimits1

ActivePowerLimitsAdder newActivePowerLimits1()

Create an adder to add a new ActivePowerLimits in the selected OperationalLimitsGroup on side 1.

If there's no selected group, the adder will also create a new group with the default name and set it as selected. This operation is performed when the limits are created via OperationalLimitsAdder.add(), only if the limits to add are valid.

Returns:

an adder allowing to create a new ActivePowerLimits in the selected OperationalLimitsGroup on side 1.

newApparentPowerLimits1

ApparentPowerLimitsAdder newApparentPowerLimits1()

Create an adder to add a new ApparentPowerLimits in the selected OperationalLimitsGroup on side 1.

If there's no selected group, the adder will also create a new group with the default name and set it as selected. This operation is performed when the limits are created via OperationalLimitsAdder.add(), only if the limits to add are valid.

Returns:

an adder allowing to create a new ApparentPowerLimits in the selected OperationalLimitsGroup on side 1.

getOperationalLimitsGroups2

Collection<OperationalLimitsGroup> getOperationalLimitsGroups2()

Get the collection of the defined OperationalLimitsGroup on side 2.

Returns:

the OperationalLimitsGroup s on side 2.

getSelectedOperationalLimitsGroupId2

Optional<String> getSelectedOperationalLimitsGroupId2()

Get the OperationalLimitsGroup corresponding to an ID on side 2.

Returns:

the OperationalLimitsGroup of the given ID on side 2 if any, an empty Optional otherwise.

getOperationalLimitsGroup2

Optional<OperationalLimitsGroup> getOperationalLimitsGroup2(String id)

Get the OperationalLimitsGroup corresponding to an ID on side 2.

Returns:

the OperationalLimitsGroup of the given ID on side 2 if any, an empty Optional otherwise.

getSelectedOperationalLimitsGroup2

Optional<OperationalLimitsGroup> getSelectedOperationalLimitsGroup2()

Get the selected OperationalLimitsGroup on side 2.

Returns:

the selected OperationalLimitsGroup on side 2 if any, an empty Optional otherwise.

newOperationalLimitsGroup2

OperationalLimitsGroup newOperationalLimitsGroup2(String id)

Create a new OperationalLimitsGroup on side 2 with the given ID.

If a group of the given ID already exists, it is replaced silently.

Returns:

the newly created group OperationalLimitsGroup.

setSelectedOperationalLimitsGroup2

void setSelectedOperationalLimitsGroup2(String id)

Set the OperationalLimitsGroup corresponding to the given ID as as the selected one on side 2.

Throw a PowsyblException if the ID doesn't correspond to any existing group.

Throw an NullPointerException if the ID is null. To reset the selected group, use cancelSelectedOperationalLimitsGroup2().

Parameters:

id - an ID of OperationalLimitsGroup

removeOperationalLimitsGroup2

void removeOperationalLimitsGroup2(String id)

Remove the OperationalLimitsGroup corresponding to the given ID on side 2.

Throw an NullPointerException if the ID is null.

Parameters:

id - an ID of OperationalLimitsGroup

cancelSelectedOperationalLimitsGroup2

void cancelSelectedOperationalLimitsGroup2()

Cancel the selected OperationalLimitsGroup on side 2.

After calling this method, no OperationalLimitsGroup is selected on side 2.

getCurrentLimits2

default Optional<CurrentLimits> getCurrentLimits2()

Get the CurrentLimits of the selected OperationalLimitsGroup on side 2.

Returns:

CurrentLimits of the selected OperationalLimitsGroup on side 2 if any, null otherwise.

getNullableCurrentLimits2

default CurrentLimits getNullableCurrentLimits2()

Get the CurrentLimits of the selected OperationalLimitsGroup on side 2.

Returns:

CurrentLimits of the selected OperationalLimitsGroup on side 2 if any, null otherwise.

getActivePowerLimits2

default Optional<ActivePowerLimits> getActivePowerLimits2()

Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 2.

Returns:

ActivePowerLimits of the selected OperationalLimitsGroup on side 2 if any, an empty Optional otherwise.

getNullableActivePowerLimits2

default ActivePowerLimits getNullableActivePowerLimits2()

Get the ActivePowerLimits of the selected OperationalLimitsGroup on side 2.

Returns:

ActivePowerLimits of the selected OperationalLimitsGroup on side 2 if any, null otherwise.

getApparentPowerLimits2

default Optional<ApparentPowerLimits> getApparentPowerLimits2()

Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 2.

Returns:

ApparentPowerLimits of the selected OperationalLimitsGroup on side 2 if any, an empty Optional otherwise.

getNullableApparentPowerLimits2

default ApparentPowerLimits getNullableApparentPowerLimits2()

Get the ApparentPowerLimits of the selected OperationalLimitsGroup on side 2.

Returns:

ApparentPowerLimits of the selected OperationalLimitsGroup on side 2 if any, null otherwise.

newCurrentLimits2

CurrentLimitsAdder newCurrentLimits2()

Create an adder to add a new CurrentLimits in the selected OperationalLimitsGroup on side 2.

If there's no selected group, the adder will also create a new group with the default name and set it as selected. This operation is performed when the limits are created via OperationalLimitsAdder.add(), only if the limits to add are valid.

Returns:

an adder allowing to create a new CurrentLimits in the selected OperationalLimitsGroup on side 2.

newActivePowerLimits2

ActivePowerLimitsAdder newActivePowerLimits2()

Create an adder to add a new ActivePowerLimits in the selected OperationalLimitsGroup on side 2.

If there's no selected group, the adder will also create a new group with the default name and set it as selected. This operation is performed when the limits are created via OperationalLimitsAdder.add(), only if the limits to add are valid.

Returns:

an adder allowing to create a new ActivePowerLimits in the selected OperationalLimitsGroup on side 2.

newApparentPowerLimits2

ApparentPowerLimitsAdder newApparentPowerLimits2()

Create an adder to add a new ApparentPowerLimits in the selected OperationalLimitsGroup on side 2.

If there's no selected group, the adder will also create a new group with the default name and set it as selected. This operation is performed when the limits are created via OperationalLimitsAdder.add(), only if the limits to add are valid.

Returns:

an adder allowing to create a new ApparentPowerLimits in the selected OperationalLimitsGroup on side 2.

getCurrentLimits

default Optional<CurrentLimits> getCurrentLimits(TwoSides side)

getActivePowerLimits

default Optional<ActivePowerLimits> getActivePowerLimits(TwoSides side)

getApparentPowerLimits

default Optional<ApparentPowerLimits> getApparentPowerLimits(TwoSides side)

getLimits

default Optional<? extends LoadingLimits> getLimits(LimitType type,
 TwoSides side)

getNullableCurrentLimits

default CurrentLimits getNullableCurrentLimits(TwoSides side)

getNullableActivePowerLimits

default ActivePowerLimits getNullableActivePowerLimits(TwoSides side)

getNullableApparentPowerLimits

default ApparentPowerLimits getNullableApparentPowerLimits(TwoSides side)

getNullableLimits

default LoadingLimits getNullableLimits(LimitType type,
 TwoSides side)

isOverloaded

boolean isOverloaded()

Only checks overloading for LimitType.Current and permanent limits

isOverloaded

boolean isOverloaded(double limitReductionValue)

Only checks overloading for LimitType.Current and permanent limits

getOverloadDuration

int getOverloadDuration()

checkPermanentLimit

boolean checkPermanentLimit(TwoSides side,
 double limitReductionValue,
 LimitType type)

checkPermanentLimit

boolean checkPermanentLimit(TwoSides side,
 LimitType type)

checkPermanentLimit1

boolean checkPermanentLimit1(double limitReductionValue,
 LimitType type)

checkPermanentLimit1

boolean checkPermanentLimit1(LimitType type)

checkPermanentLimit2

boolean checkPermanentLimit2(double limitReductionValue,
 LimitType type)

checkPermanentLimit2

boolean checkPermanentLimit2(LimitType type)

checkTemporaryLimits

Overload checkTemporaryLimits(TwoSides side,
 double limitReductionValue,
 LimitType type)

checkTemporaryLimits

Overload checkTemporaryLimits(TwoSides side,
 LimitType type)

checkTemporaryLimits1

Overload checkTemporaryLimits1(double limitReductionValue,
 LimitType type)

checkTemporaryLimits1

Overload checkTemporaryLimits1(LimitType type)

checkTemporaryLimits2

Overload checkTemporaryLimits2(double limitReductionValue,
 LimitType type)

checkTemporaryLimits2

Overload checkTemporaryLimits2(LimitType type)