Package com.powsybl.iidm.network.limitmodification

Class LimitsComputer.NoModificationsImpl

java.lang.Object

com.powsybl.iidm.network.limitmodification.AbstractLimitsComputerWithCache<Identifiable<?>,LoadingLimits>

com.powsybl.iidm.network.limitmodification.LimitsComputer.NoModificationsImpl

All Implemented Interfaces:

LimitsComputer<Identifiable<?>,LoadingLimits>

Enclosing interface:

LimitsComputer<P,L>

public static class LimitsComputer.NoModificationsImpl
extends AbstractLimitsComputerWithCache<Identifiable<?>,LoadingLimits>

An implementation of LimitsComputer only retrieving the limits without applying modifications.

Nested Class Summary

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

Constructor	Description
NoModificationsImpl()

Method Summary

Modifier and Type	Method	Description
Optional<LimitsContainer<LoadingLimits>>	computeLimits(Identifiable<?> identifiable, LimitType limitType, ThreeSides side, boolean monitoringOnly)	Retrieve the limits of processable corresponding to the given limits type and side, then apply on them the modifications configured in the current LimitsComputer.
protected Optional<LimitsContainer<LoadingLimits>>	computeUncachedLimits(Identifiable<?> processable, LimitType limitType, ThreeSides side, boolean monitoringOnly)	Retrieve the limits on processable then apply modifications on them.

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

clearCache, putInCache

Methods inherited from class java.lang.Object

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

Constructor Details

NoModificationsImpl

public NoModificationsImpl()

Method Details

computeLimits

public Optional<LimitsContainer<LoadingLimits>> computeLimits(Identifiable<?> identifiable,
 LimitType limitType,
 ThreeSides side,
 boolean monitoringOnly)

Description copied from class: AbstractLimitsComputerWithCache

Retrieve the limits of processable corresponding to the given limits type and side, then apply on them the modifications configured in the current LimitsComputer.

The result of this method contains both originals and altered limits.

Resulting limits are stored in an internal cache, by (identifier's ID, limit type, side), in order to avoid unnecessary re-computation. If needed, this cache can be cleared using AbstractLimitsComputerWithCache.clearCache().

Specified by:

computeLimits in interface LimitsComputer<Identifiable<?>,LoadingLimits>

Overrides:

computeLimits in class AbstractLimitsComputerWithCache<Identifiable<?>,LoadingLimits>

Parameters:

identifiable - The network element for which the reduced limits must be computed

limitType - The type of the limits to process

side - The side of processable on which the limits should be retrieved

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 the original limits and the altered ones

computeUncachedLimits

protected Optional<LimitsContainer<LoadingLimits>> computeUncachedLimits(Identifiable<?> 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<Identifiable<?>,LoadingLimits>

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.