Package com.powsybl.iidm.network.limitmodification

Interface LimitsComputer<P,L>

All Known Implementing Classes:

AbstractLimitReductionsApplier, AbstractLimitsComputerWithCache, DefaultLimitReductionsApplier, LimitsComputer.NoModificationsImpl

public interface LimitsComputer<P,L>

Interface for classes responsible for accessing limits of generic type LimitsComputer from a network element of generic type LimitsComputer, and potentially creating a modified copy of them.

Author:

Olivier Perrin <olivier.perrin at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LimitsComputer.NoModificationsImpl	An implementation of LimitsComputer only retrieving the limits without applying modifications.

Field Summary

Fields

Modifier and Type	Field	Description
static final LimitsComputer<Identifiable<?>,LoadingLimits>	NO_MODIFICATIONS	An implementation of LimitsComputer only retrieving the limits of the network elements without applying modifications.

Method Summary

Modifier and Type	Method	Description
Optional<LimitsContainer<L>>	computeLimits(P processable, 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.

Field Details

NO_MODIFICATIONS

static final LimitsComputer<Identifiable<?>,LoadingLimits> NO_MODIFICATIONS

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

Method Details

computeLimits

Optional<LimitsContainer<L>> computeLimits(P processable,
 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.

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

Parameters:

processable - The network element for which the altered 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