Package com.powsybl.loadflow

Class LoadFlowResultImpl.ComponentResultImpl

java.lang.Object

com.powsybl.loadflow.LoadFlowResultImpl.ComponentResultImpl

All Implemented Interfaces:

LoadFlowResult.ComponentResult

Enclosing class:

LoadFlowResultImpl

public static class LoadFlowResultImpl.ComponentResultImpl
extends Object
implements LoadFlowResult.ComponentResult

Nested Class Summary

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

LoadFlowResult.ComponentResult.Status

Constructor Summary

Constructors

Constructor	Description
ComponentResultImpl(int connectedComponentNum, int synchronousComponentNum, LoadFlowResult.ComponentResult.Status status, int iterationCount, String slackBusId, double slackBusActivePowerMismatch, double distributedActivePower)
ComponentResultImpl(int connectedComponentNum, int synchronousComponentNum, LoadFlowResult.ComponentResult.Status status, String statusText, Map<String,String> metrics, int iterationCount, String referenceBusId, List<LoadFlowResult.SlackBusResult> slackBusResults, double distributedActivePower)

Method Summary

Modifier and Type	Method	Description
int	getConnectedComponentNum()	Get connected component number.
double	getDistributedActivePower()	If distributed slack is activated LoadFlowParameters.isDistributedSlack(), the active power in MW that has been distributed from slack bus to generators/loads (depending of LoadFlowParameters.getBalanceType() value)
int	getIterationCount()	Get iteration count.
Map<String,String>	getMetrics()	Get metrics.
String	getReferenceBusId()	Get the reference bus id (angle reference)
double	getSlackBusActivePowerMismatch()	Get slack bus active power mismatch in MW.
String	getSlackBusId()	Get the slack bus id.
List<LoadFlowResult.SlackBusResult>	getSlackBusResults()	get slack results of all slack buses
LoadFlowResult.ComponentResult.Status	getStatus()	Get detailed status of the computation on this component.
String	getStatusText()	Get status text of the computation on this component.
int	getSynchronousComponentNum()	Get synchronous component number.

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentResultImpl

public ComponentResultImpl(int connectedComponentNum,
 int synchronousComponentNum,
 LoadFlowResult.ComponentResult.Status status,
 int iterationCount,
 String slackBusId,
 double slackBusActivePowerMismatch,
 double distributedActivePower)

ComponentResultImpl

public ComponentResultImpl(int connectedComponentNum,
 int synchronousComponentNum,
 LoadFlowResult.ComponentResult.Status status,
 String statusText,
 Map<String,String> metrics,
 int iterationCount,
 String referenceBusId,
 List<LoadFlowResult.SlackBusResult> slackBusResults,
 double distributedActivePower)

Method Details

getConnectedComponentNum

public int getConnectedComponentNum()

Description copied from interface: LoadFlowResult.ComponentResult

Get connected component number.

Specified by:

getConnectedComponentNum in interface LoadFlowResult.ComponentResult

Returns:

connected component number

getSynchronousComponentNum

public int getSynchronousComponentNum()

Description copied from interface: LoadFlowResult.ComponentResult

Get synchronous component number.

Specified by:

getSynchronousComponentNum in interface LoadFlowResult.ComponentResult

Returns:

component number

getStatus

public LoadFlowResult.ComponentResult.Status getStatus()

Description copied from interface: LoadFlowResult.ComponentResult

Get detailed status of the computation on this component.

Specified by:

getStatus in interface LoadFlowResult.ComponentResult

Returns:

the detailed status of the computation on this component

getStatusText

public String getStatusText()

Description copied from interface: LoadFlowResult.ComponentResult

Get status text of the computation on this component. Status text is implementation specific and can be used to provide additional information about e.g. failed reason.

Specified by:

getStatusText in interface LoadFlowResult.ComponentResult

Returns:

the status text of the computation on this component

getMetrics

public Map<String,String> getMetrics()

Description copied from interface: LoadFlowResult.ComponentResult

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

Specified by:

getMetrics in interface LoadFlowResult.ComponentResult

Returns:

the metrics for this component

getIterationCount

public int getIterationCount()

Description copied from interface: LoadFlowResult.ComponentResult

Get iteration count.

Specified by:

getIterationCount in interface LoadFlowResult.ComponentResult

Returns:

the iteration count

getReferenceBusId

public String getReferenceBusId()

Description copied from interface: LoadFlowResult.ComponentResult

Get the reference bus id (angle reference)

Specified by:

getReferenceBusId in interface LoadFlowResult.ComponentResult

Returns:

the reference bus id

getSlackBusResults

public List<LoadFlowResult.SlackBusResult> getSlackBusResults()

Description copied from interface: LoadFlowResult.ComponentResult

get slack results of all slack buses

Specified by:

getSlackBusResults in interface LoadFlowResult.ComponentResult

Returns:

list of slack results

getSlackBusId

public String getSlackBusId()

Description copied from interface: LoadFlowResult.ComponentResult

Get the slack bus id.

Specified by:

getSlackBusId in interface LoadFlowResult.ComponentResult

Returns:

the slack bus id

getSlackBusActivePowerMismatch

public double getSlackBusActivePowerMismatch()

Description copied from interface: LoadFlowResult.ComponentResult

Get slack bus active power mismatch in MW.

Specified by:

getSlackBusActivePowerMismatch in interface LoadFlowResult.ComponentResult

Returns:

the slack bus active power mismatch in MW

getDistributedActivePower

public double getDistributedActivePower()

Description copied from interface: LoadFlowResult.ComponentResult

If distributed slack is activated LoadFlowParameters.isDistributedSlack(), the active power in MW that has been distributed from slack bus to generators/loads (depending of LoadFlowParameters.getBalanceType() value)

Specified by:

getDistributedActivePower in interface LoadFlowResult.ComponentResult

Returns:

the active power in MW that has been distributed