Package com.powsybl.loadflow

Class LoadFlowResultImpl

java.lang.Object

com.powsybl.loadflow.LoadFlowResultImpl

All Implemented Interfaces:

LoadFlowResult

public class LoadFlowResultImpl
extends Object
implements LoadFlowResult

Author:

Christian Biasuzzi <[email protected]>, Damien Jeandemange <damien.jeandemange at artelys.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoadFlowResultImpl.ComponentResultImpl
static class	LoadFlowResultImpl.SlackBusResultImpl

Nested classes/interfaces inherited from interface com.powsybl.loadflow.LoadFlowResult

LoadFlowResult.ComponentResult, LoadFlowResult.SlackBusResult, LoadFlowResult.Status

Constructor Summary

Constructors

Constructor	Description
LoadFlowResultImpl(boolean ok, Map<String,String> metrics, String logs)
LoadFlowResultImpl(boolean ok, Map<String,String> metrics, String logs, List<LoadFlowResult.ComponentResult> componentResults)

Method Summary

Modifier and Type	Method	Description
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.
boolean	isOk()	Get the global status.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.loadflow.LoadFlowResult

isFailed, isFullyConverged, isPartiallyConverged

Constructor Details

LoadFlowResultImpl

public LoadFlowResultImpl(boolean ok,
 Map<String,String> metrics,
 String logs)

LoadFlowResultImpl

public LoadFlowResultImpl(boolean ok,
 Map<String,String> metrics,
 String logs,
 List<LoadFlowResult.ComponentResult> componentResults)

Method Details

isOk

public boolean isOk()

Description copied from interface: LoadFlowResult

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().

Specified by:

isOk in interface LoadFlowResult

Returns:

the global status

getStatus

public LoadFlowResult.Status getStatus()

Description copied from interface: LoadFlowResult

Get the global status.

Specified by:

getStatus in interface LoadFlowResult

Returns:

the global status

getMetrics

public Map<String,String> getMetrics()

Description copied from interface: LoadFlowResult

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

Specified by:

getMetrics in interface LoadFlowResult

Returns:

the metrics

getLogs

public String getLogs()

Description copied from interface: LoadFlowResult

Get logs.

Specified by:

getLogs in interface LoadFlowResult

Returns:

logs

getComponentResults

public List<LoadFlowResult.ComponentResult> getComponentResults()

Description copied from interface: LoadFlowResult

Get per component results.

Specified by:

getComponentResults in interface LoadFlowResult

Returns:

per component results