Package com.powsybl.loadflow
Class LoadFlowResultImpl
java.lang.Object
com.powsybl.loadflow.LoadFlowResultImpl
- All Implemented Interfaces:
LoadFlowResult
- Author:
- Christian Biasuzzi <[email protected]>, Damien Jeandemange <damien.jeandemange at artelys.com>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from interface com.powsybl.loadflow.LoadFlowResult
LoadFlowResult.ComponentResult, LoadFlowResult.SlackBusResult, LoadFlowResult.Status
-
Constructor Summary
ConstructorDescriptionLoadFlowResultImpl
(boolean ok, Map<String, String> metrics, String logs) LoadFlowResultImpl
(boolean ok, Map<String, String> metrics, String logs, List<LoadFlowResult.ComponentResult> componentResults) -
Method Summary
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
-
LoadFlowResultImpl
-
-
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 usingLoadFlowResult.ComponentResult.getStatus()
.- Specified by:
isOk
in interfaceLoadFlowResult
- Returns:
- the global status
-
getStatus
Description copied from interface:LoadFlowResult
Get the global status.- Specified by:
getStatus
in interfaceLoadFlowResult
- Returns:
- the global status
-
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 interfaceLoadFlowResult
- Returns:
- the metrics
-
getLogs
Description copied from interface:LoadFlowResult
Get logs.- Specified by:
getLogs
in interfaceLoadFlowResult
- Returns:
- logs
-
getComponentResults
Description copied from interface:LoadFlowResult
Get per component results.- Specified by:
getComponentResults
in interfaceLoadFlowResult
- Returns:
- per component results
-