Package com.powsybl.iidm.network

Interface FlowsLimitsHolder

All Known Subinterfaces:

DanglingLine, ThreeWindingsTransformer.Leg

public interface FlowsLimitsHolder

Author:

Miora Ralambotiana <miora.ralambotiana at rte-france.com>

Method Summary

Modifier and Type	Method	Description
void	cancelSelectedOperationalLimitsGroup()	Cancel the selected OperationalLimitsGroup.
default Optional<ActivePowerLimits>	getActivePowerLimits()	Get the ActivePowerLimits of the selected OperationalLimitsGroup.
default Optional<ApparentPowerLimits>	getApparentPowerLimits()	Get the ApparentPowerLimits of the selected OperationalLimitsGroup.
default Optional<CurrentLimits>	getCurrentLimits()	Get the CurrentLimits of the selected OperationalLimitsGroup.
default ActivePowerLimits	getNullableActivePowerLimits()	Get the ActivePowerLimits of the selected OperationalLimitsGroup.
default ApparentPowerLimits	getNullableApparentPowerLimits()	Get the ApparentPowerLimits of the selected OperationalLimitsGroup.
default CurrentLimits	getNullableCurrentLimits()	Get the CurrentLimits of the selected OperationalLimitsGroup.
Optional<OperationalLimitsGroup>	getOperationalLimitsGroup(String id)	Get the OperationalLimitsGroup corresponding to an ID.
Collection<OperationalLimitsGroup>	getOperationalLimitsGroups()	Get the collection of the defined OperationalLimitsGroup.
Optional<OperationalLimitsGroup>	getSelectedOperationalLimitsGroup()	Get the selected OperationalLimitsGroup.
Optional<String>	getSelectedOperationalLimitsGroupId()	Get the ID of the selected OperationalLimitsGroup.
ActivePowerLimitsAdder	newActivePowerLimits()	Create an adder to add a new ActivePowerLimits in the selected OperationalLimitsGroup.
ApparentPowerLimitsAdder	newApparentPowerLimits()	Create an adder to add a new ApparentPowerLimits in the selected OperationalLimitsGroup.
CurrentLimitsAdder	newCurrentLimits()	Create an adder to add a new CurrentLimits in the selected OperationalLimitsGroup.
OperationalLimitsGroup	newOperationalLimitsGroup(String id)	Create a new OperationalLimitsGroup with the given ID.
void	removeOperationalLimitsGroup(String id)	Remove the OperationalLimitsGroup corresponding to the given ID.
void	setSelectedOperationalLimitsGroup(String id)	Set the OperationalLimitsGroup corresponding to the given ID as as the selected one.

Method Details

getOperationalLimitsGroups

Collection<OperationalLimitsGroup> getOperationalLimitsGroups()

Get the collection of the defined OperationalLimitsGroup.

Returns:

the OperationalLimitsGroup s.

getSelectedOperationalLimitsGroupId

Optional<String> getSelectedOperationalLimitsGroupId()

Get the ID of the selected OperationalLimitsGroup.

Returns:

the ID of the selected OperationalLimitsGroup if any, an empty Optional otherwise.

getOperationalLimitsGroup

Optional<OperationalLimitsGroup> getOperationalLimitsGroup(String id)

Get the OperationalLimitsGroup corresponding to an ID.

Returns:

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

getSelectedOperationalLimitsGroup

Optional<OperationalLimitsGroup> getSelectedOperationalLimitsGroup()

Get the selected OperationalLimitsGroup.

Returns:

the selected OperationalLimitsGroup if any, an empty Optional otherwise.

newOperationalLimitsGroup

OperationalLimitsGroup newOperationalLimitsGroup(String id)

Create a new OperationalLimitsGroup with the given ID.

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

Returns:

the newly created group OperationalLimitsGroup.

setSelectedOperationalLimitsGroup

void setSelectedOperationalLimitsGroup(String id)

Set the OperationalLimitsGroup corresponding to the given ID as as the selected one.

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 cancelSelectedOperationalLimitsGroup().

Parameters:

id - an ID of OperationalLimitsGroup

removeOperationalLimitsGroup

void removeOperationalLimitsGroup(String id)

Remove the OperationalLimitsGroup corresponding to the given ID.

Throw an NullPointerException if the ID is null.

Parameters:

id - an ID of OperationalLimitsGroup

cancelSelectedOperationalLimitsGroup

void cancelSelectedOperationalLimitsGroup()

Cancel the selected OperationalLimitsGroup.

After calling this method, no OperationalLimitsGroup is selected.

getCurrentLimits

default Optional<CurrentLimits> getCurrentLimits()

Get the CurrentLimits of the selected OperationalLimitsGroup.

Returns:

CurrentLimits of the selected OperationalLimitsGroup if any, null otherwise.

getNullableCurrentLimits

default CurrentLimits getNullableCurrentLimits()

Get the CurrentLimits of the selected OperationalLimitsGroup.

Returns:

CurrentLimits of the selected OperationalLimitsGroup if any, null otherwise.

getActivePowerLimits

default Optional<ActivePowerLimits> getActivePowerLimits()

Get the ActivePowerLimits of the selected OperationalLimitsGroup.

Returns:

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

getNullableActivePowerLimits

default ActivePowerLimits getNullableActivePowerLimits()

Get the ActivePowerLimits of the selected OperationalLimitsGroup.

Returns:

ActivePowerLimits of the selected OperationalLimitsGroup if any, null otherwise.

getApparentPowerLimits

default Optional<ApparentPowerLimits> getApparentPowerLimits()

Get the ApparentPowerLimits of the selected OperationalLimitsGroup.

Returns:

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

getNullableApparentPowerLimits

default ApparentPowerLimits getNullableApparentPowerLimits()

Get the ApparentPowerLimits of the selected OperationalLimitsGroup.

Returns:

ApparentPowerLimits of the selected OperationalLimitsGroup if any, null otherwise.

newCurrentLimits

CurrentLimitsAdder newCurrentLimits()

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

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.

newApparentPowerLimits

ApparentPowerLimitsAdder newApparentPowerLimits()

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

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.

newActivePowerLimits

ActivePowerLimitsAdder newActivePowerLimits()

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

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.