Package com.powsybl.security.limitreduction

Class AbstractLimitReductionsApplier<P,L>

java.lang.Object

com.powsybl.iidm.network.limitmodification.AbstractLimitsComputerWithCache<P,L>

com.powsybl.security.limitreduction.AbstractLimitReductionsApplier<P,L>

All Implemented Interfaces:

LimitsComputer<P,L>

Direct Known Subclasses:

DefaultLimitReductionsApplier

public abstract class AbstractLimitReductionsApplier<P,L>
extends AbstractLimitsComputerWithCache<P,L>

Abstract class responsible for computing reduced limits using a list of LimitReduction.

Author:

Sophie Frasnedo <sophie.frasnedo at rte-france.com>, Olivier Perrin <olivier.perrin at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractLimitReductionsApplier.OriginalLimitsGetter<P,L>	Interface for objects allowing to retrieve limits (of generic type AbstractLimitReductionsApplier.OriginalLimitsGetter) from an object manageable by the LimitsComputer (of generic type AbstractLimitReductionsApplier.OriginalLimitsGetter).

Nested classes/interfaces inherited from interface com.powsybl.iidm.network.limitmodification.LimitsComputer

LimitsComputer.NoModificationsImpl

Field Summary

Fields inherited from interface com.powsybl.iidm.network.limitmodification.LimitsComputer

NO_MODIFICATIONS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLimitReductionsApplier(List<LimitReduction> limitReductionList)	Create a new AbstractLimitReductionsApplier using a list of reductions.

Method Summary

Modifier and Type	Method	Description
protected abstract NetworkElement	asNetworkElement(P processable)	Return a NetworkElement representation of processable (itself if it already is a NetworkElement or an adapter).
protected Optional<LimitsContainer<L>>	computeUncachedLimits(P processable, LimitType limitType, ThreeSides side, boolean monitoringOnly)	Retrieve the limits on processable then apply modifications on them.
protected abstract AbstractLimitsReducerCreator<L,AbstractLimitsReducer<L>>	getLimitsReducerCreator()	Return the AbstractLimitsReducer creator, which will be used to create an object of type AbstractLimitReductionsApplier containing the modified limits.
protected abstract AbstractLimitReductionsApplier.OriginalLimitsGetter<P,L>	getOriginalLimitsGetter()	Return an AbstractLimitReductionsApplier.OriginalLimitsGetter allowing to retrieve AbstractLimitReductionsApplier from a network element of type AbstractLimitReductionsApplier.
protected static boolean	isContingencyInContingencyContext(ContingencyContext contingencyContext, String contingencyId)
protected static boolean	isNetworkElementAffectedByLimitReduction(NetworkElement networkElement, LimitReduction limitReduction)
protected static boolean	isPermanentLimitAffectedByLimitReduction(LimitReduction limitReduction)
protected static boolean	isTemporaryLimitAffectedByLimitReduction(int temporaryLimitAcceptableDuration, LimitReduction limitReduction)
void	setWorkingContingency(String contingencyId)	Change the contingency for which the reduced limits must be computed.

Methods inherited from class com.powsybl.iidm.network.limitmodification.AbstractLimitsComputerWithCache

clearCache, computeLimits, putInCache

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractLimitReductionsApplier

protected AbstractLimitReductionsApplier(List<LimitReduction> limitReductionList)

Create a new AbstractLimitReductionsApplier using a list of reductions.

Parameters:

limitReductionList - the list of the reductions to use when computing reduced limits.

Method Details

computeUncachedLimits

protected Optional<LimitsContainer<L>> computeUncachedLimits(P processable,
 LimitType limitType,
 ThreeSides side,
 boolean monitoringOnly)

Description copied from class: AbstractLimitsComputerWithCache

Retrieve the limits on processable then apply modifications on them.

If no modifications applies on the resulting LimitsContainer must contains the same object for the original and the reduced limits.

This function is called when the corresponding limits were not found in the cache.

This function is responsible for the addition of the computed limit in the cache (via the AbstractLimitsComputerWithCache.putInCache(P, com.powsybl.iidm.network.LimitType, com.powsybl.iidm.network.ThreeSides, boolean, com.powsybl.iidm.network.limitmodification.result.LimitsContainer<L>) method).

Specified by:

computeUncachedLimits in class AbstractLimitsComputerWithCache<P,L>

Parameters:

processable - the network element for which the limits must be retrieved and modified

limitType - the type of limits to process

side - the side of the network element where to retrieve the original limits

monitoringOnly - If true, compute the limits to use for a monitoring only use case. If false, compute the limits to use for a monitoring + action use case.

Returns:

an object containing both the original and the modified limits.

getOriginalLimitsGetter

protected abstract AbstractLimitReductionsApplier.OriginalLimitsGetter<P,L> getOriginalLimitsGetter()

Return an AbstractLimitReductionsApplier.OriginalLimitsGetter allowing to retrieve AbstractLimitReductionsApplier from a network element of type AbstractLimitReductionsApplier.

Returns:

an original limits getter

getLimitsReducerCreator

protected abstract AbstractLimitsReducerCreator<L,AbstractLimitsReducer<L>> getLimitsReducerCreator()

Return the AbstractLimitsReducer creator, which will be used to create an object of type AbstractLimitReductionsApplier containing the modified limits.

Returns:

the creator for AbstractLimitsReducer

asNetworkElement

protected abstract NetworkElement asNetworkElement(P processable)

Return a NetworkElement representation of processable (itself if it already is a NetworkElement or an adapter).

Parameters:

processable - the object which limits should be computed.

Returns:

a NetworkElement representation of processable

setWorkingContingency

public void setWorkingContingency(String contingencyId)

Change the contingency for which the reduced limits must be computed.

Parameters:

contingencyId - the ID of the new contingency, or null if you study the pre-contingency state.

isContingencyInContingencyContext

protected static boolean isContingencyInContingencyContext(ContingencyContext contingencyContext,
 String contingencyId)

isNetworkElementAffectedByLimitReduction

protected static boolean isNetworkElementAffectedByLimitReduction(NetworkElement networkElement,
 LimitReduction limitReduction)

isPermanentLimitAffectedByLimitReduction

protected static boolean isPermanentLimitAffectedByLimitReduction(LimitReduction limitReduction)

isTemporaryLimitAffectedByLimitReduction

protected static boolean isTemporaryLimitAffectedByLimitReduction(int temporaryLimitAcceptableDuration,
 LimitReduction limitReduction)