Package com.powsybl.iidm.network

Class ValidationUtil

java.lang.Object

com.powsybl.iidm.network.ValidationUtil

public final class ValidationUtil
extends Object

Author:

Geoffroy Jamgotchian

Method Summary

Modifier and Type	Method	Description
static void	checkActivePowerLimits(Validable validable, double minP, double maxP)
static void	checkActivePowerLimits(Validable validable, double minP, double maxP, double p)	Deprecated. Use checkActivePowerLimits(Validable, double, double) instead.
static ValidationLevel	checkActivePowerSetpoint(Validable validable, double activePowerSetpoint, boolean throwException)
static ValidationLevel	checkActivePowerSetpoint(Validable validable, double activePowerSetpoint, boolean throwException, Reporter reporter)
static ValidationLevel	checkActivePowerSetpoint(Validable validable, double activePowerSetpoint, ValidationLevel validationLevel)
static ValidationLevel	checkActivePowerSetpoint(Validable validable, double activePowerSetpoint, ValidationLevel validationLevel, Reporter reporter)
static void	checkB(Validable validable, double b)
static void	checkB1(Validable validable, double b1)
static void	checkB2(Validable validable, double b2)
static void	checkBmax(Validable validable, double bMax)
static void	checkBmin(Validable validable, double bMin)
static void	checkBPerSection(Validable validable, double sectionB)
static void	checkCaseDate(Validable validable, org.joda.time.DateTime caseDate)
static void	checkConnected(Validable validable, Boolean connected)
static ValidationLevel	checkConvertersMode(Validable validable, HvdcLine.ConvertersMode converterMode, boolean throwException)
static ValidationLevel	checkConvertersMode(Validable validable, HvdcLine.ConvertersMode converterMode, boolean throwException, Reporter reporter)
static void	checkEnergySource(Validable validable, EnergySource energySource)
static void	checkForecastDistance(Validable validable, int forecastDistance)
static void	checkG(Validable validable, double g)
static void	checkG1(Validable validable, double g1)
static void	checkG2(Validable validable, double g2)
static ValidationLevel	checkHvdcActivePowerSetpoint(Validable validable, double activePowerSetpoint, boolean throwException)
static ValidationLevel	checkHvdcActivePowerSetpoint(Validable validable, double activePowerSetpoint, boolean throwException, Reporter reporter)
static void	checkHvdcMaxP(Validable validable, double maxP)
static void	checkLinearBPerSection(Validable validable, double bPerSection)	Deprecated. Use checkBPerSection(Validable, double) instead.
static void	checkLoadType(Validable validable, LoadType loadType)
static void	checkLossFactor(Validable validable, float lossFactor)
static void	checkMaximumSectionCount(Validable validable, int maximumSectionCount)
static void	checkMaxP(Validable validable, double maxP)
static void	checkMinP(Validable validable, double minP)
static void	checkNominalV(Validable validable, double nominalV)
static ValidationLevel	checkOnlyOneTapChangerRegulatingEnabled(Validable validable, Set<TapChanger<?,?>> tapChangersNotIncludingTheModified, boolean regulating, boolean throwException)
static ValidationLevel	checkOnlyOneTapChangerRegulatingEnabled(Validable validable, Set<TapChanger<?,?>> tapChangersNotIncludingTheModified, boolean regulating, boolean throwException, Reporter reporter)
static ValidationLevel	checkP0(Validable validable, double p0, boolean throwException, Reporter reporter)
static ValidationLevel	checkP0(Validable validable, double p0, ValidationLevel validationLevel)
static ValidationLevel	checkP0(Validable validable, double p0, ValidationLevel validationLevel, Reporter reporter)
static void	checkPermanentLimit(Validable validable, double permanentLimit)
static ValidationLevel	checkPhaseTapChangerRegulation(Validable validable, PhaseTapChanger.RegulationMode regulationMode, double regulationValue, boolean regulating, Terminal regulationTerminal, Network network, boolean throwException)
static ValidationLevel	checkPhaseTapChangerRegulation(Validable validable, PhaseTapChanger.RegulationMode regulationMode, double regulationValue, boolean regulating, Terminal regulationTerminal, Network network, boolean throwException, Reporter reporter)
static void	checkPowerFactor(Validable validable, double powerFactor)
static ValidationLevel	checkQ0(Validable validable, double q0, boolean throwException, Reporter reporter)
static ValidationLevel	checkQ0(Validable validable, double q0, ValidationLevel validationLevel)
static ValidationLevel	checkQ0(Validable validable, double q0, ValidationLevel validationLevel, Reporter reporter)
static void	checkR(Validable validable, double r)
static void	checkRatedS(Validable validable, double ratedS)
static void	checkRatedU(Validable validable, double ratedU, String num)
static void	checkRatedU1(Validable validable, double ratedU1)
static void	checkRatedU2(Validable validable, double ratedU2)
static ValidationLevel	checkRatioTapChangerRegulation(Validable validable, boolean regulating, boolean loadTapChangingCapabilities, Terminal regulationTerminal, double targetV, Network network, boolean throwException, Reporter reporter)
static ValidationLevel	checkRatioTapChangerRegulation(Validable validable, boolean regulating, boolean loadTapChangingCapabilities, Terminal regulationTerminal, double targetV, Network network, ValidationLevel validationLevel)
static ValidationLevel	checkRatioTapChangerRegulation(Validable validable, boolean regulating, boolean loadTapChangingCapabilities, Terminal regulationTerminal, double targetV, Network network, ValidationLevel validationLevel, Reporter reporter)
static void	checkRegulatingTerminal(Validable validable, Terminal regulatingTerminal, Network network)
static ValidationLevel	checkSections(Validable validable, Integer currentSectionCount, int maximumSectionCount, boolean throwException, Reporter reporter)
static ValidationLevel	checkSections(Validable validable, Integer currentSectionCount, int maximumSectionCount, ValidationLevel validationLevel)
static ValidationLevel	checkSections(Validable validable, Integer currentSectionCount, int maximumSectionCount, ValidationLevel validationLevel, Reporter reporter)
static ValidationLevel	checkSvcRegulator(Validable validable, double voltageSetpoint, double reactivePowerSetpoint, StaticVarCompensator.RegulationMode regulationMode, boolean throwException, Reporter reporter)
static ValidationLevel	checkSvcRegulator(Validable validable, double voltageSetpoint, double reactivePowerSetpoint, StaticVarCompensator.RegulationMode regulationMode, ValidationLevel validationLevel)
static ValidationLevel	checkSvcRegulator(Validable validable, double voltageSetpoint, double reactivePowerSetpoint, StaticVarCompensator.RegulationMode regulationMode, ValidationLevel validationLevel, Reporter reporter)
static ValidationLevel	checkTargetDeadband(Validable validable, String validableType, boolean regulating, double targetDeadband, boolean throwsException, Reporter reporter)
static ValidationLevel	checkTargetDeadband(Validable validable, String validableType, boolean regulating, double targetDeadband, ValidationLevel validationLevel)
static ValidationLevel	checkTargetDeadband(Validable validable, String validableType, boolean regulating, double targetDeadband, ValidationLevel validationLevel, Reporter reporter)
static void	checkTopologyKind(Validable validable, TopologyKind topologyKind)
static ValidationLevel	checkVoltageControl(Validable validable, boolean voltageRegulatorOn, double voltageSetpoint, boolean throwException, Reporter reporter)
static ValidationLevel	checkVoltageControl(Validable validable, boolean voltageRegulatorOn, double voltageSetpoint, ValidationLevel validationLevel)
static ValidationLevel	checkVoltageControl(Validable validable, boolean voltageRegulatorOn, double voltageSetpoint, ValidationLevel validationLevel, Reporter reporter)
static ValidationLevel	checkVoltageControl(Validable validable, Boolean voltageRegulatorOn, double voltageSetpoint, double reactivePowerSetpoint, boolean throwException, Reporter reporter)
static ValidationLevel	checkVoltageControl(Validable validable, Boolean voltageRegulatorOn, double voltageSetpoint, double reactivePowerSetpoint, ValidationLevel validationLevel)
static ValidationLevel	checkVoltageControl(Validable validable, Boolean voltageRegulatorOn, double voltageSetpoint, double reactivePowerSetpoint, ValidationLevel validationLevel, Reporter reporter)
static void	checkVoltageLimits(Validable validable, double lowVoltageLimit, double highVoltageLimit)
static void	checkX(Validable validable, double x)
static PowsyblException	createUndefinedValueGetterException()
static PowsyblException	createUnsetMethodException()
static void	throwExceptionOrLogError(Validable validable, String message, boolean throwException, Reporter reporter)
static void	throwExceptionOrLogError(Validable validable, String message, ValidationLevel validationLevel)
static void	throwExceptionOrLogError(Validable validable, String message, ValidationLevel validationLevel, Reporter reporter)
static ValidationLevel	validate(Collection<Identifiable<?>> identifiables, boolean allChecks, boolean throwException, ValidationLevel previous, Reporter reporter)

Methods inherited from class java.lang.Object

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

Method Detail

createUndefinedValueGetterException

public static PowsyblException createUndefinedValueGetterException()

createUnsetMethodException

public static PowsyblException createUnsetMethodException()

throwExceptionOrLogError

public static void throwExceptionOrLogError(Validable validable,
                                            String message,
                                            ValidationLevel validationLevel)

throwExceptionOrLogError

public static void throwExceptionOrLogError(Validable validable,
                                            String message,
                                            boolean throwException,
                                            Reporter reporter)

throwExceptionOrLogError

public static void throwExceptionOrLogError(Validable validable,
                                            String message,
                                            ValidationLevel validationLevel,
                                            Reporter reporter)

checkActivePowerSetpoint

public static ValidationLevel checkActivePowerSetpoint(Validable validable,
                                                       double activePowerSetpoint,
                                                       ValidationLevel validationLevel)

checkActivePowerSetpoint

public static ValidationLevel checkActivePowerSetpoint(Validable validable,
                                                       double activePowerSetpoint,
                                                       ValidationLevel validationLevel,
                                                       Reporter reporter)

checkActivePowerSetpoint

public static ValidationLevel checkActivePowerSetpoint(Validable validable,
                                                       double activePowerSetpoint,
                                                       boolean throwException)

checkActivePowerSetpoint

public static ValidationLevel checkActivePowerSetpoint(Validable validable,
                                                       double activePowerSetpoint,
                                                       boolean throwException,
                                                       Reporter reporter)

checkHvdcActivePowerSetpoint

public static ValidationLevel checkHvdcActivePowerSetpoint(Validable validable,
                                                           double activePowerSetpoint,
                                                           boolean throwException)

checkHvdcActivePowerSetpoint

public static ValidationLevel checkHvdcActivePowerSetpoint(Validable validable,
                                                           double activePowerSetpoint,
                                                           boolean throwException,
                                                           Reporter reporter)

checkActivePowerLimits

public static void checkActivePowerLimits(Validable validable,
                                          double minP,
                                          double maxP)

checkActivePowerLimits

@Deprecated(since="4.3.0")
public static void checkActivePowerLimits(Validable validable,
                                          double minP,
                                          double maxP,
                                          double p)

Deprecated.

Use checkActivePowerLimits(Validable, double, double) instead.

checkTargetDeadband

public static ValidationLevel checkTargetDeadband(Validable validable,
                                                  String validableType,
                                                  boolean regulating,
                                                  double targetDeadband,
                                                  ValidationLevel validationLevel)

checkTargetDeadband

public static ValidationLevel checkTargetDeadband(Validable validable,
                                                  String validableType,
                                                  boolean regulating,
                                                  double targetDeadband,
                                                  ValidationLevel validationLevel,
                                                  Reporter reporter)

checkTargetDeadband

public static ValidationLevel checkTargetDeadband(Validable validable,
                                                  String validableType,
                                                  boolean regulating,
                                                  double targetDeadband,
                                                  boolean throwsException,
                                                  Reporter reporter)

checkVoltageControl

public static ValidationLevel checkVoltageControl(Validable validable,
                                                  boolean voltageRegulatorOn,
                                                  double voltageSetpoint,
                                                  ValidationLevel validationLevel)

checkVoltageControl

public static ValidationLevel checkVoltageControl(Validable validable,
                                                  boolean voltageRegulatorOn,
                                                  double voltageSetpoint,
                                                  ValidationLevel validationLevel,
                                                  Reporter reporter)

checkVoltageControl

public static ValidationLevel checkVoltageControl(Validable validable,
                                                  boolean voltageRegulatorOn,
                                                  double voltageSetpoint,
                                                  boolean throwException,
                                                  Reporter reporter)

checkVoltageControl

public static ValidationLevel checkVoltageControl(Validable validable,
                                                  Boolean voltageRegulatorOn,
                                                  double voltageSetpoint,
                                                  double reactivePowerSetpoint,
                                                  ValidationLevel validationLevel)

checkVoltageControl

public static ValidationLevel checkVoltageControl(Validable validable,
                                                  Boolean voltageRegulatorOn,
                                                  double voltageSetpoint,
                                                  double reactivePowerSetpoint,
                                                  ValidationLevel validationLevel,
                                                  Reporter reporter)

checkVoltageControl

public static ValidationLevel checkVoltageControl(Validable validable,
                                                  Boolean voltageRegulatorOn,
                                                  double voltageSetpoint,
                                                  double reactivePowerSetpoint,
                                                  boolean throwException,
                                                  Reporter reporter)

checkRatedS

public static void checkRatedS(Validable validable,
                               double ratedS)

checkEnergySource

public static void checkEnergySource(Validable validable,
                                     EnergySource energySource)

checkMinP

public static void checkMinP(Validable validable,
                             double minP)

checkMaxP

public static void checkMaxP(Validable validable,
                             double maxP)

checkHvdcMaxP

public static void checkHvdcMaxP(Validable validable,
                                 double maxP)

checkRegulatingTerminal

public static void checkRegulatingTerminal(Validable validable,
                                           Terminal regulatingTerminal,
                                           Network network)

checkLoadType

public static void checkLoadType(Validable validable,
                                 LoadType loadType)

checkP0

public static ValidationLevel checkP0(Validable validable,
                                      double p0,
                                      ValidationLevel validationLevel)

checkP0

public static ValidationLevel checkP0(Validable validable,
                                      double p0,
                                      ValidationLevel validationLevel,
                                      Reporter reporter)

checkP0

public static ValidationLevel checkP0(Validable validable,
                                      double p0,
                                      boolean throwException,
                                      Reporter reporter)

checkQ0

public static ValidationLevel checkQ0(Validable validable,
                                      double q0,
                                      ValidationLevel validationLevel)

checkQ0

public static ValidationLevel checkQ0(Validable validable,
                                      double q0,
                                      ValidationLevel validationLevel,
                                      Reporter reporter)

checkQ0

public static ValidationLevel checkQ0(Validable validable,
                                      double q0,
                                      boolean throwException,
                                      Reporter reporter)

checkR

public static void checkR(Validable validable,
                          double r)

checkX

public static void checkX(Validable validable,
                          double x)

checkG1

public static void checkG1(Validable validable,
                           double g1)

checkG2

public static void checkG2(Validable validable,
                           double g2)

checkB1

public static void checkB1(Validable validable,
                           double b1)

checkB2

public static void checkB2(Validable validable,
                           double b2)

checkG

public static void checkG(Validable validable,
                          double g)

checkB

public static void checkB(Validable validable,
                          double b)

checkNominalV

public static void checkNominalV(Validable validable,
                                 double nominalV)

checkVoltageLimits

public static void checkVoltageLimits(Validable validable,
                                      double lowVoltageLimit,
                                      double highVoltageLimit)

checkTopologyKind

public static void checkTopologyKind(Validable validable,
                                     TopologyKind topologyKind)

checkCaseDate

public static void checkCaseDate(Validable validable,
                                 org.joda.time.DateTime caseDate)

checkForecastDistance

public static void checkForecastDistance(Validable validable,
                                         int forecastDistance)

checkLinearBPerSection

@Deprecated(since="4.2.0")
public static void checkLinearBPerSection(Validable validable,
                                          double bPerSection)

Deprecated.

Use checkBPerSection(Validable, double) instead.

checkBPerSection

public static void checkBPerSection(Validable validable,
                                    double sectionB)

checkMaximumSectionCount

public static void checkMaximumSectionCount(Validable validable,
                                            int maximumSectionCount)

checkSections

public static ValidationLevel checkSections(Validable validable,
                                            Integer currentSectionCount,
                                            int maximumSectionCount,
                                            ValidationLevel validationLevel)

checkSections

public static ValidationLevel checkSections(Validable validable,
                                            Integer currentSectionCount,
                                            int maximumSectionCount,
                                            ValidationLevel validationLevel,
                                            Reporter reporter)

checkSections

public static ValidationLevel checkSections(Validable validable,
                                            Integer currentSectionCount,
                                            int maximumSectionCount,
                                            boolean throwException,
                                            Reporter reporter)

checkRatedU

public static void checkRatedU(Validable validable,
                               double ratedU,
                               String num)

checkRatedU1

public static void checkRatedU1(Validable validable,
                                double ratedU1)

checkRatedU2

public static void checkRatedU2(Validable validable,
                                double ratedU2)

checkSvcRegulator

public static ValidationLevel checkSvcRegulator(Validable validable,
                                                double voltageSetpoint,
                                                double reactivePowerSetpoint,
                                                StaticVarCompensator.RegulationMode regulationMode,
                                                ValidationLevel validationLevel)

checkSvcRegulator

public static ValidationLevel checkSvcRegulator(Validable validable,
                                                double voltageSetpoint,
                                                double reactivePowerSetpoint,
                                                StaticVarCompensator.RegulationMode regulationMode,
                                                ValidationLevel validationLevel,
                                                Reporter reporter)

checkSvcRegulator

public static ValidationLevel checkSvcRegulator(Validable validable,
                                                double voltageSetpoint,
                                                double reactivePowerSetpoint,
                                                StaticVarCompensator.RegulationMode regulationMode,
                                                boolean throwException,
                                                Reporter reporter)

checkBmin

public static void checkBmin(Validable validable,
                             double bMin)

checkBmax

public static void checkBmax(Validable validable,
                             double bMax)

checkRatioTapChangerRegulation

public static ValidationLevel checkRatioTapChangerRegulation(Validable validable,
                                                             boolean regulating,
                                                             boolean loadTapChangingCapabilities,
                                                             Terminal regulationTerminal,
                                                             double targetV,
                                                             Network network,
                                                             ValidationLevel validationLevel)

checkRatioTapChangerRegulation

public static ValidationLevel checkRatioTapChangerRegulation(Validable validable,
                                                             boolean regulating,
                                                             boolean loadTapChangingCapabilities,
                                                             Terminal regulationTerminal,
                                                             double targetV,
                                                             Network network,
                                                             ValidationLevel validationLevel,
                                                             Reporter reporter)

checkRatioTapChangerRegulation

public static ValidationLevel checkRatioTapChangerRegulation(Validable validable,
                                                             boolean regulating,
                                                             boolean loadTapChangingCapabilities,
                                                             Terminal regulationTerminal,
                                                             double targetV,
                                                             Network network,
                                                             boolean throwException,
                                                             Reporter reporter)

checkPhaseTapChangerRegulation

public static ValidationLevel checkPhaseTapChangerRegulation(Validable validable,
                                                             PhaseTapChanger.RegulationMode regulationMode,
                                                             double regulationValue,
                                                             boolean regulating,
                                                             Terminal regulationTerminal,
                                                             Network network,
                                                             boolean throwException)

checkPhaseTapChangerRegulation

public static ValidationLevel checkPhaseTapChangerRegulation(Validable validable,
                                                             PhaseTapChanger.RegulationMode regulationMode,
                                                             double regulationValue,
                                                             boolean regulating,
                                                             Terminal regulationTerminal,
                                                             Network network,
                                                             boolean throwException,
                                                             Reporter reporter)

checkOnlyOneTapChangerRegulatingEnabled

public static ValidationLevel checkOnlyOneTapChangerRegulatingEnabled(Validable validable,
                                                                      Set<TapChanger<?,?>> tapChangersNotIncludingTheModified,
                                                                      boolean regulating,
                                                                      boolean throwException)

checkOnlyOneTapChangerRegulatingEnabled

public static ValidationLevel checkOnlyOneTapChangerRegulatingEnabled(Validable validable,
                                                                      Set<TapChanger<?,?>> tapChangersNotIncludingTheModified,
                                                                      boolean regulating,
                                                                      boolean throwException,
                                                                      Reporter reporter)

checkConvertersMode

public static ValidationLevel checkConvertersMode(Validable validable,
                                                  HvdcLine.ConvertersMode converterMode,
                                                  boolean throwException)

checkConvertersMode

public static ValidationLevel checkConvertersMode(Validable validable,
                                                  HvdcLine.ConvertersMode converterMode,
                                                  boolean throwException,
                                                  Reporter reporter)

checkPowerFactor

public static void checkPowerFactor(Validable validable,
                                    double powerFactor)

checkConnected

public static void checkConnected(Validable validable,
                                  Boolean connected)

checkPermanentLimit

public static void checkPermanentLimit(Validable validable,
                                       double permanentLimit)

checkLossFactor

public static void checkLossFactor(Validable validable,
                                   float lossFactor)

validate

public static ValidationLevel validate(Collection<Identifiable<?>> identifiables,
                                       boolean allChecks,
                                       boolean throwException,
                                       ValidationLevel previous,
                                       Reporter reporter)