com.powsybl.sensitivity

Class SensitivityComputationResults

java.lang.Object

com.powsybl.sensitivity.SensitivityComputationResults

public class SensitivityComputationResults
extends java.lang.Object

Sensitivity computation results

Mainly composed of the list of sensitivity values

See Also:

SensitivityValue

Constructor Summary

Constructors

Constructor and Description
SensitivityComputationResults(boolean ok, java.util.Map<java.lang.String,java.lang.String> metrics, java.lang.String logs, java.util.List<SensitivityValue> values) Hades2 sensitivity computation results

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLogs() Get computation logs.
java.util.Map<java.lang.String,java.lang.String>	getMetrics() Get some metrics about computation execution.
SensitivityValue	getSensitivityValue(SensitivityFactor factor) Get the sensitivity value associated with given factor
SensitivityValue	getSensitivityValue(SensitivityFunction function, SensitivityVariable variable) Get the sensitivity value associated with given function and given variable
java.util.Collection<SensitivityValue>	getSensitivityValues() Get a collection of all the sensitivity values.
java.util.Collection<SensitivityValue>	getSensitivityValuesByFunction(SensitivityFunction function) Get a collection of all the sensitivity values associated with given function.
java.util.Collection<SensitivityValue>	getSensitivityValuesByVariable(SensitivityVariable variable) Get a collection of all the sensitivity values associated with given variable
boolean	isOk() Get the status of the sensitivity computation

Methods inherited from class java.lang.Object

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

Constructor Detail

SensitivityComputationResults

public SensitivityComputationResults(boolean ok,
                                     java.util.Map<java.lang.String,java.lang.String> metrics,
                                     java.lang.String logs,
                                     java.util.List<SensitivityValue> values)

Hades2 sensitivity computation results

Parameters:

ok - true if the computation succeeded, false otherwise

metrics - map of metrics about the computation

logs - computation logs

values - result values of the senstivity computation. Must be non null.

Method Detail

isOk

public boolean isOk()

Get the status of the sensitivity computation

Returns:

true if the computation is ok, false otherwise

getMetrics

public java.util.Map<java.lang.String,java.lang.String> getMetrics()

Get some metrics about computation execution. Content may vary a lot depending of the implementation

Returns:

the metrics of the execution

getLogs

public java.lang.String getLogs()

Get computation logs.

Returns:

the computation logs

getSensitivityValues

public java.util.Collection<SensitivityValue> getSensitivityValues()

Get a collection of all the sensitivity values.

Returns:

a collection of all the sensitivity values.

getSensitivityValuesByFunction

public java.util.Collection<SensitivityValue> getSensitivityValuesByFunction(SensitivityFunction function)

Get a collection of all the sensitivity values associated with given function.

Parameters:

function - sensitivity function

Returns:

a collection of all the sensitivity values associated with given function

getSensitivityValuesByVariable

public java.util.Collection<SensitivityValue> getSensitivityValuesByVariable(SensitivityVariable variable)

Get a collection of all the sensitivity values associated with given variable

Parameters:

variable - sensitivity variable

Returns:

a collection of all the sensitivity values associated with given variable

getSensitivityValue

public SensitivityValue getSensitivityValue(SensitivityFunction function,
                                            SensitivityVariable variable)

Get the sensitivity value associated with given function and given variable

Parameters:

function - sensitivity function

variable - sensitivity variable

Returns:

the sensitivity value associated with given function and given variable

getSensitivityValue

public SensitivityValue getSensitivityValue(SensitivityFactor factor)

Get the sensitivity value associated with given factor

Parameters:

factor - sensitivity factor

Returns:

the sensitivity value associated with given function and given variable