Package com.powsybl.sensitivity
Class SensitivityValue
- java.lang.Object
-
- com.powsybl.sensitivity.SensitivityValue
-
public class SensitivityValue extends Object
Elementary result value of sensitivity analysis. Associates a value to a sensitivity factor.- Author:
- Sebastien Murgey <sebastien.murgey at rte-france.com>
- See Also:
SensitivityFactor
-
-
Constructor Summary
Constructors Constructor Description SensitivityValue(SensitivityFactor sensitivityFactor, double value, double functionReference, double variableReference)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SensitivityFactor
getFactor()
Get the sensitivity factordouble
getFunctionReference()
Get the value of the function in the reference network statedouble
getValue()
Get the value of the sensitivitydouble
getVariableReference()
Get the value of the variable in the reference network state
-
-
-
Constructor Detail
-
SensitivityValue
public SensitivityValue(SensitivityFactor sensitivityFactor, double value, double functionReference, double variableReference)
Constructor- Parameters:
sensitivityFactor
- sensitivity factor inputvalue
- value of the sensitivityfunctionReference
- reference value of the functionvariableReference
- reference value of the variable
-
-
Method Detail
-
getFactor
public SensitivityFactor getFactor()
Get the sensitivity factor- Returns:
- the sensitivity factor
-
getValue
public double getValue()
Get the value of the sensitivity- Returns:
- the value of the sensitivity, and NaN if not computed
-
getFunctionReference
public double getFunctionReference()
Get the value of the function in the reference network state- Returns:
- the reference value of the function, and NaN if not computed
-
getVariableReference
public double getVariableReference()
Get the value of the variable in the reference network state- Returns:
- the reference value of the variable, and NaN if not computed
-
-