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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoadFlowResultImpl.ComponentResultImpl

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

LoadFlowResult.ComponentResult

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.
boolean	isOk()	Get the global status.

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

isOk

public boolean isOk()

Description copied from interface: LoadFlowResult

Get the global status. It is expected to be ok if at least one component has converged.

Specified by:

isOk 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