Package com.powsybl.loadflow

Interface LoadFlowResult

All Known Implementing Classes:

LoadFlowResultImpl

public interface LoadFlowResult

Loadflow result API.

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>, Damien Jeandemange <damien.jeandemange at artelys.com>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LoadFlowResult.ComponentResult	Result for one component
static interface	LoadFlowResult.SlackBusResult	Result for one slack bus
static enum	LoadFlowResult.Status	Load Flow global calculation status, derived from all LoadFlowResult.ComponentResult, using LoadFlowResult.ComponentResult.Status, but excluding non-calculated component i.e. excluding components having status NO_CALCULATION

Method Summary

Modifier and Type	Method	Description
default List<LoadFlowResult.ComponentResult>	getComponentResults()	Get per component results.
String	getLogs()	Get logs.
Map<String,String>	getMetrics()	Get metrics.
LoadFlowResult.Status	getStatus()	Get the global status.
default boolean	isFailed()	Indicates if failed
default boolean	isFullyConverged()	Indicates if fully converged
boolean	isOk()	Deprecated. use getStatus() or isFullyConverged() ()} or isPartiallyConverged() instead
default boolean	isPartiallyConverged()	Indicates if partially converged

Method Details

isOk

@Deprecated(since="6.1.0")
boolean isOk()

Deprecated.

use getStatus() or isFullyConverged() ()} or isPartiallyConverged() instead

Get the global status. Must be set to true/ok if at least one component has converged. Note that when computing multiple components (islands), it is preferable to evaluate the individual component status using LoadFlowResult.ComponentResult.getStatus().

Returns:

the global status

getStatus

LoadFlowResult.Status getStatus()

Get the global status.

Returns:

the global status

isFullyConverged

default boolean isFullyConverged()

Indicates if fully converged

Returns:

true if status is LoadFlowResult.Status.FULLY_CONVERGED

isPartiallyConverged

default boolean isPartiallyConverged()

Indicates if partially converged

Returns:

true if status is LoadFlowResult.Status.PARTIALLY_CONVERGED

isFailed

default boolean isFailed()

Indicates if failed

Returns:

true if status is LoadFlowResult.Status.FAILED

getMetrics

Map<String,String> getMetrics()

Get metrics. Metrics are generic key/value pairs and are specific to a loadflow implementation.

Returns:

the metrics

getLogs

String getLogs()

Get logs.

Returns:

logs

getComponentResults

default List<LoadFlowResult.ComponentResult> getComponentResults()

Get per component results.

Returns:

per component results