Interface LimitViolationDetector

    • Method Detail

      • checkCurrent

        default void checkCurrent​(Contingency contingency,
                                  Branch branch,
                                  Branch.Side side,
                                  double currentValue,
                                  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,
                                  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,
                                  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,
                                  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,
                                  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,
                                  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,
                              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,
                          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,
                          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,
                          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,
                          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,
                          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,
                          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,
                      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.