com.powsybl.iidm.network

Interface CurrentLimits

All Known Implementing Classes:

CurrentLimitsImpl

public interface CurrentLimits

Current limits are defined by:

• A permanent limit (A)
• Any number of temporary limits. A permanent limit (A) has an acceptable duration (s). The branch can safely stay between the previous limit (could be another temporary limit or the permanent limit) and this limit during the acceptable duration. A NaN temporay limit value means infinite.

The following diagram shows current areas and corresponding acceptable duration for a permanent limit and 3 temporary limits with x, y and z acceptable durations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CurrentLimits.TemporaryLimit Temporary current limit.

Method Summary

Modifier and Type	Method and Description
double	getPermanentLimit() Get the permanent limit in A.
CurrentLimits.TemporaryLimit	getTemporaryLimit(int acceptableDuration) Get a temporary limit from its acceptable duration.
java.util.Collection<CurrentLimits.TemporaryLimit>	getTemporaryLimits() Get a list of temporary limits ordered by descending duration.
double	getTemporaryLimitValue(int acceptableDuration) Get a temporary limit value from its acceptable duration.
CurrentLimits	setPermanentLimit(double permanentLimit) Set the permanent limit in A.

Method Detail

getPermanentLimit

double getPermanentLimit()

Get the permanent limit in A.

Returns:

the permanent limit in A.

setPermanentLimit

CurrentLimits setPermanentLimit(double permanentLimit)

Set the permanent limit in A.

Parameters:

permanentLimit - the permanent limit in A

Returns:

itself for method chaining

getTemporaryLimits

java.util.Collection<CurrentLimits.TemporaryLimit> getTemporaryLimits()

Get a list of temporary limits ordered by descending duration.

Returns:

a list of temporary limits ordered by descending duration

getTemporaryLimit

CurrentLimits.TemporaryLimit getTemporaryLimit(int acceptableDuration)

Get a temporary limit from its acceptable duration. Return null if there is non temporary limit with this acceptable duration.

Parameters:

acceptableDuration - acceptable duration in second

Returns:

the temporary limit

getTemporaryLimitValue

double getTemporaryLimitValue(int acceptableDuration)

Get a temporary limit value from its acceptable duration. Return NaN if there is non temporary limit with this acceptable duration.

Parameters:

acceptableDuration - acceptable duration in second

Returns:

the temporary limit value or NaN if there is no temporary limit for this acceptable duration