Package com.powsybl.loadflow
Interface LoadFlowResult
-
- All Known Implementing Classes:
LoadFlowResultImpl
public interface LoadFlowResult
Loadflow result API.- Author:
- Geoffroy Jamgotchian
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
LoadFlowResult.ComponentResult
Result for one component
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default List<LoadFlowResult.ComponentResult>
getComponentResults()
Get per component results.String
getLogs()
Get logs.Map<String,String>
getMetrics()
Get metrics.boolean
isOk()
Get the global status.
-
-
-
Method Detail
-
isOk
boolean isOk()
Get the global status. It is expected to be ok if at least one component has converged.- Returns:
- the global status
-
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
-
-