ShortCircuitAnalysisResult (powsybl 4.7.0-RC2 API)

java.lang.Object
- com.powsybl.commons.extensions.AbstractExtendable<ShortCircuitAnalysisResult>
- - com.powsybl.shortcircuit.ShortCircuitAnalysisResult

All Implemented Interfaces:

Extendable<ShortCircuitAnalysisResult>
```
public class ShortCircuitAnalysisResult
extends AbstractExtendable<ShortCircuitAnalysisResult>
```
Results of a short-circuit computation. Will contain an exhaustive list of computed short-circuit current values, and a list of LimitViolations.

Author:

Boubakeur Brahimi

Constructor Summary

Constructors
Constructor Description

ShortCircuitAnalysisResult(List<FaultResult> faultResults, List<LimitViolation> limitViolations)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<FaultResult>`	`getFaultResults()`	A list of results, for each fault which have been simulated.
`List<LimitViolation>`	`getLimitViolations()`	The list of limit violations: for instance when the computed short-circuit current on a given equipment is higher than the maximum admissible value for that equipment.
`NetworkMetadata`	`getNetworkMetadata()`
`ShortCircuitAnalysisResult`	`setNetworkMetadata(NetworkMetadata networkMetadata)`

Methods inherited from class com.powsybl.commons.extensions.AbstractExtendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.powsybl.commons.extensions.Extendable
newExtension

- Constructor Detail
  - ShortCircuitAnalysisResult
```
public ShortCircuitAnalysisResult(List<FaultResult> faultResults,
                                  List<LimitViolation> limitViolations)
```
- Method Detail
  - getFaultResults
```
public List<FaultResult> getFaultResults()
```
    A list of results, for each fault which have been simulated.
  - getLimitViolations
```
public List<LimitViolation> getLimitViolations()
```
    The list of limit violations: for instance when the computed short-circuit current on a given equipment is higher than the maximum admissible value for that equipment. In general, the equipment ID can be completed by the side where the violation occurs. In a first simple approach, the equipment is a voltage level, and no side is needed.
  - getNetworkMetadata
```
public NetworkMetadata getNetworkMetadata()
```
  - setNetworkMetadata
```
public ShortCircuitAnalysisResult setNetworkMetadata(NetworkMetadata networkMetadata)
```