Package com.powsybl.loadflow

Interface LoadFlowResult.ComponentResult

All Known Implementing Classes:
LoadFlowResultImpl.ComponentResultImpl
Enclosing interface:
LoadFlowResult
public static interface LoadFlowResult.ComponentResult
Result for one component

  • Method Details

    • getConnectedComponentNum

      int getConnectedComponentNum()
      Get connected component number.
      Returns:
      connected component number

    • getSynchronousComponentNum

      int getSynchronousComponentNum()
      Get synchronous component number.
      Returns:
      component number

    • getStatus

      LoadFlowResult.ComponentResult.Status getStatus()
      Get detailed status of the computation on this component.
      Returns:
      the detailed status of the computation on this component

    • getStatusText

      String getStatusText()
      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.
      Returns:
      the status text of the computation on this component

    • getMetrics

      Map<String,String> getMetrics()
      Get metrics. Metrics are generic key/value pairs and are specific to a loadflow implementation.
      Returns:
      the metrics for this component

    • getIterationCount

      int getIterationCount()
      Get iteration count.
      Returns:
      the iteration count

    • getReferenceBusId

      String getReferenceBusId()
      Get the reference bus id (angle reference)
      Returns:
      the reference bus id

    • getSlackBusResults

      List<LoadFlowResult.SlackBusResult> getSlackBusResults()
      get slack results of all slack buses
      Returns:
      list of slack results

    • getSlackBusId

      @Deprecated(since="6.1.0") String getSlackBusId()
      Deprecated.
      use getSlackBusResults() instead
      Get the slack bus id.
      Returns:
      the slack bus id

    • getSlackBusActivePowerMismatch

      @Deprecated(since="6.1.0") double getSlackBusActivePowerMismatch()
      Deprecated.
      use getSlackBusResults() instead
      Get slack bus active power mismatch in MW.
      Returns:
      the slack bus active power mismatch in MW

    • getDistributedActivePower

      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)
      Returns:
      the active power in MW that has been distributed