com.powsybl.security

Interface LimitViolationDetector

All Known Implementing Classes:

AbstractContingencyBlindDetector, AbstractLimitViolationDetector, AbstractLimitViolationDetector, DefaultLimitViolationDetector, DefaultLimitViolationDetector

public interface LimitViolationDetector

Being given some physical values (currents, voltages, ...) for network elements, is in charge of deciding whether there are limit violations or not.

Author:

Sylvain Leclerc

Method Summary

Modifier and Type	Method and Description
default void	checkAll(Contingency contingency, Network network, java.util.function.Consumer<LimitViolation> consumer) Checks whether the current and voltage values on all equipments of the specified Network should be considered as LimitViolations.
void	checkAll(Network network, java.util.function.Consumer<LimitViolation> consumer) Checks whether the current and voltage values on all equipments of the specified Network should be considered as LimitViolations.
void	checkCurrent(Branch branch, Branch.Side side, java.util.function.Consumer<LimitViolation> consumer) Checks whether the current value on the specified side of the specified Branch should be considered as a LimitViolation or not.
void	checkCurrent(Branch branch, Branch.Side side, double currentValue, java.util.function.Consumer<LimitViolation> consumer) Checks whether the specified current value on the specified side of the specified Branch should be considered as a LimitViolation or not.
void	checkCurrent(Branch branch, java.util.function.Consumer<LimitViolation> consumer) Checks whether the current value on both sides of the specified Branch should be considered as LimitViolation(s).
default void	checkCurrent(Contingency contingency, Branch branch, Branch.Side side, java.util.function.Consumer<LimitViolation> consumer) Checks whether the current value on the specified side of the specified Branch should be considered as a LimitViolation or not.
default void	checkCurrent(Contingency contingency, Branch branch, Branch.Side side, double currentValue, java.util.function.Consumer<LimitViolation> consumer) Checks whether the specified current value on the specified side of the specified Branch should be considered as a LimitViolation or not.
default void	checkCurrent(Contingency contingency, Branch branch, java.util.function.Consumer<LimitViolation> consumer) Checks whether the current value on both sides of the specified Branch should be considered as LimitViolation(s).
void	checkVoltage(Bus bus, java.util.function.Consumer<LimitViolation> consumer) Checks whether the voltage value on the specified Bus should be considered as a LimitViolation or not.
void	checkVoltage(Bus bus, double voltageValue, java.util.function.Consumer<LimitViolation> consumer) Checks whether the specified voltage value on the specified Bus should be considered as a LimitViolation or not.
default void	checkVoltage(Contingency contingency, Bus bus, java.util.function.Consumer<LimitViolation> consumer) Checks whether the voltage value on the specified Bus should be considered as a LimitViolation or not.
default void	checkVoltage(Contingency contingency, Bus bus, double voltageValue, java.util.function.Consumer<LimitViolation> consumer) Checks whether the specified voltage value on the specified Bus should be considered as a LimitViolation or not.
default void	checkVoltage(Contingency contingency, VoltageLevel voltageLevel, java.util.function.Consumer<LimitViolation> consumer) Checks whether the voltage value on the specified VoltageLevel should be considered as a LimitViolation or not.
void	checkVoltage(VoltageLevel voltageLevel, java.util.function.Consumer<LimitViolation> consumer) Checks whether the voltage value on the specified VoltageLevel should be considered as a LimitViolation or not.

Method Detail

checkCurrent

default void checkCurrent(Contingency contingency,
                          Branch branch,
                          Branch.Side side,
                          double currentValue,
                          java.util.function.Consumer<LimitViolation> consumer)

Checks whether the specified current value on the specified side of the specified Branch should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

contingency - The contingency for which current must be checked, null for N situation.

branch - The branch on which the current must be checked.

side - The side of the branch on which the current must be checked.

currentValue - The current value to be checked, in A.

consumer - Will be fed with possibly created limit violations.

checkCurrent

default void checkCurrent(Contingency contingency,
                          Branch branch,
                          Branch.Side side,
                          java.util.function.Consumer<LimitViolation> consumer)

Checks whether the current value on the specified side of the specified Branch should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

contingency - The contingency for which current must be checked, null for N situation.

branch - The branch on which the current must be checked.

side - The side of the branch on which the current must be checked.

consumer - Will be fed with possibly created limit violations.

checkVoltage

default void checkVoltage(Contingency contingency,
                          Bus bus,
                          double voltageValue,
                          java.util.function.Consumer<LimitViolation> consumer)

Checks whether the specified voltage value on the specified Bus should be considered as a LimitViolation or not. In case it should, returns the corresponding limit violation.

Parameters:

contingency - The contingency for which current must be checked, null for N situation.

bus - The bus on which the voltage must be checked.

voltageValue - The voltage value to be checked, in V.

consumer - Will be fed with possibly created limit violations.

checkVoltage

default void checkVoltage(Contingency contingency,
                          Bus bus,
                          java.util.function.Consumer<LimitViolation> consumer)

Checks whether the voltage value on the specified Bus should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

contingency - The contingency for which current must be checked, null for N situation.

bus - The bus on which the voltage must be checked.

consumer - Will be fed with possibly created limit violations.

checkVoltage

default void checkVoltage(Contingency contingency,
                          VoltageLevel voltageLevel,
                          java.util.function.Consumer<LimitViolation> consumer)

Checks whether the voltage value on the specified VoltageLevel should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

contingency - The contingency for which current must be checked, null for N situation.

voltageLevel - The voltage level on which the voltage must be checked.

consumer - Will be fed with possibly created limit violations.

checkCurrent

default void checkCurrent(Contingency contingency,
                          Branch branch,
                          java.util.function.Consumer<LimitViolation> consumer)

Checks whether the current value on both sides of the specified Branch should be considered as LimitViolation(s). In case it should, feeds the consumer with it.

Parameters:

contingency - The contingency for which current must be checked, null for N situation.

branch - The branch on which the current must be checked.

consumer - Will be fed with possibly created limit violations.

checkAll

default void checkAll(Contingency contingency,
                      Network network,
                      java.util.function.Consumer<LimitViolation> consumer)

Checks whether the current and voltage values on all equipments of the specified Network should be considered as LimitViolations. In case it should, feeds the consumer with it.

Parameters:

contingency - The contingency for which current must be checked, null for N situation.

network - The network on which physical values must be checked.

consumer - Will be fed with possibly created limit violations.

checkCurrent

void checkCurrent(Branch branch,
                  Branch.Side side,
                  double currentValue,
                  java.util.function.Consumer<LimitViolation> consumer)

Checks whether the specified current value on the specified side of the specified Branch should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

branch - The branch on which the current must be checked.

side - The side of the branch on which the current must be checked.

currentValue - The current value to be checked, in A.

consumer - Will be fed with possibly created limit violations.

checkCurrent

void checkCurrent(Branch branch,
                  Branch.Side side,
                  java.util.function.Consumer<LimitViolation> consumer)

Checks whether the current value on the specified side of the specified Branch should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

branch - The branch on which the current must be checked.

side - The side of the branch on which the current must be checked.

consumer - Will be fed with possibly created limit violations.

checkVoltage

void checkVoltage(Bus bus,
                  double voltageValue,
                  java.util.function.Consumer<LimitViolation> consumer)

Checks whether the specified voltage value on the specified Bus should be considered as a LimitViolation or not. In case it should, returns the corresponding limit violation.

Parameters:

bus - The bus on which the voltage must be checked.

voltageValue - The voltage value to be checked, in V.

consumer - Will be fed with possibly created limit violations.

checkVoltage

void checkVoltage(Bus bus,
                  java.util.function.Consumer<LimitViolation> consumer)

Checks whether the voltage value on the specified Bus should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

bus - The bus on which the voltage must be checked.

consumer - Will be fed with possibly created limit violations.

checkVoltage

void checkVoltage(VoltageLevel voltageLevel,
                  java.util.function.Consumer<LimitViolation> consumer)

Checks whether the voltage value on the specified VoltageLevel should be considered as a LimitViolation or not. In case it should, feeds the consumer with it.

Parameters:

voltageLevel - The voltage level on which the voltage must be checked.

consumer - Will be fed with possibly created limit violations.

checkCurrent

void checkCurrent(Branch branch,
                  java.util.function.Consumer<LimitViolation> consumer)

Checks whether the current value on both sides of the specified Branch should be considered as LimitViolation(s). In case it should, feeds the consumer with it.

Parameters:

branch - The branch on which the current must be checked.

consumer - Will be fed with possibly created limit violations.

checkAll

void checkAll(Network network,
              java.util.function.Consumer<LimitViolation> consumer)

Checks whether the current and voltage values on all equipments of the specified Network should be considered as LimitViolations. In case it should, feeds the consumer with it.

Parameters:

network - The network on which physical values must be checked.

consumer - Will be fed with possibly created limit violations.