Package com.powsybl.sensitivity

Class SensitivityValue

java.lang.Object

com.powsybl.sensitivity.SensitivityValue

public class SensitivityValue
extends Object

Elementary result value of a sensitivity analysis, given the sensitivity factor and a contingency id (use null to get a pre-contingency value). The value is the impact of the variable change on the monitored equipment. The function reference gives the level of the function in the network pre-contingency state.

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

See Also:

• SensitivityFactor

Constructor Summary

Constructors

Constructor	Description
SensitivityValue(int factorIndex, int contingencyIndex, double value, double functionReference)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	getContingencyIndex()
int	getFactorIndex()
double	getFunctionReference()
double	getValue()
static SensitivityValue	parseJson(com.fasterxml.jackson.core.JsonParser parser)
String	toString()
static void	writeJson(com.fasterxml.jackson.core.JsonGenerator generator, SensitivityValue value)

Methods inherited from class java.lang.Object

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

Constructor Details

SensitivityValue

public SensitivityValue(int factorIndex,
 int contingencyIndex,
 double value,
 double functionReference)

Constructor.

Parameters:

factorIndex - the sensitivity factor index

contingencyIndex - the contingency index, -1 for pre-contingency state.

value - the sensitivity value, as a result of the computation.

functionReference - the value of the sensitivity function in the pre-contingency state.

Method Details

getFactorIndex

public int getFactorIndex()

getContingencyIndex

public int getContingencyIndex()

getValue

public double getValue()

getFunctionReference

public double getFunctionReference()

toString

public String toString()

Overrides:

toString in class Object

parseJson

public static SensitivityValue parseJson(com.fasterxml.jackson.core.JsonParser parser)

writeJson

public static void writeJson(com.fasterxml.jackson.core.JsonGenerator generator,
 SensitivityValue value)