com.powsybl.sensitivity

Class SensitivityValue

java.lang.Object

com.powsybl.sensitivity.SensitivityValue

public class SensitivityValue
extends java.lang.Object

Elementary result value of sensitivity computation. Associates a value to a sensitivity factor.

See Also:

SensitivityFactor

Constructor Summary

Constructors

Constructor and Description
SensitivityValue(SensitivityFactor sensitivityFactor, double value, double functionReference, double variableReference) Constructor

Method Summary

Modifier and Type	Method and Description
SensitivityFactor	getFactor() Get the sensitivity factor
double	getFunctionReference() Get the value of the function in the reference network state
double	getValue() Get the value of the sensitivity
double	getVariableReference() Get the value of the variable in the reference network state

Methods inherited from class java.lang.Object

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

Constructor Detail

SensitivityValue

public SensitivityValue(SensitivityFactor sensitivityFactor,
                        double value,
                        double functionReference,
                        double variableReference)

Constructor

Parameters:

sensitivityFactor - sensitivity factor input

value - value of the sensitivity

functionReference - reference value of the function

variableReference - 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