Package com.powsybl.shortcircuit

Interface ShortCircuitAnalysisProvider

All Superinterfaces:

PlatformConfigNamedProvider, Versionable

public interface ShortCircuitAnalysisProvider
extends Versionable, PlatformConfigNamedProvider

Computation results are provided asynchronously as a ShortCircuitAnalysisResult.

Implementations of that interface may typically rely on an external tool.

Author:

Anne Tilloy

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider

PlatformConfigNamedProvider.Finder

Method Summary

Modifier and Type	Method	Description
static List<ShortCircuitAnalysisProvider>	findAll()
default List<Parameter>	getSpecificParameters()	Get the list of the specific parameters.
default Optional<ExtensionJsonSerializer>	getSpecificParametersSerializer()	The serializer for implementation-specific parameters, or Optional.empty() if the implementation does not have any specific parameters, or does not support JSON serialization.
default Optional<Extension<ShortCircuitParameters>>	loadSpecificParameters(PlatformConfig config)	Reads implementation-specific parameters from platform config, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.
default Optional<Extension<ShortCircuitParameters>>	loadSpecificParameters(Map<String,String> properties)	Reads implementation-specific parameters from a Map, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.
default CompletableFuture<ShortCircuitAnalysisResult>	run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters)	Run an asynchronous single short circuit analysis job.
default CompletableFuture<ShortCircuitAnalysisResult>	run(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters, Reporter reporter)	Run an asynchronous single short circuit analysis job.
default void	updateSpecificParameters(Extension<ShortCircuitParameters> extension, Map<String,String> properties)	Updates implementation-specific parameters from a Map.

Methods inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider

getName, getPlatformConfigName

Methods inherited from interface com.powsybl.commons.Versionable

getName, getVersion

Method Detail

findAll

static List<ShortCircuitAnalysisProvider> findAll()

run

default CompletableFuture<ShortCircuitAnalysisResult> run(Network network,
                                                          List<Fault> faults,
                                                          ShortCircuitParameters parameters,
                                                          ComputationManager computationManager,
                                                          List<FaultParameters> faultParameters)

Run an asynchronous single short circuit analysis job.

Parameters:

faultParameters - parameters that define the fault about which information will be written after short circuit analysis

run

default CompletableFuture<ShortCircuitAnalysisResult> run(Network network,
                                                          List<Fault> faults,
                                                          ShortCircuitParameters parameters,
                                                          ComputationManager computationManager,
                                                          List<FaultParameters> faultParameters,
                                                          Reporter reporter)

Run an asynchronous single short circuit analysis job.

getSpecificParametersSerializer

default Optional<ExtensionJsonSerializer> getSpecificParametersSerializer()

The serializer for implementation-specific parameters, or Optional.empty() if the implementation does not have any specific parameters, or does not support JSON serialization.

Note that the actual serializer type should be ExtensionJsonSerializer<ShortCircuitParameters, MyParametersExtension> where MyParametersExtension is the specific parameters class.

loadSpecificParameters

default Optional<Extension<ShortCircuitParameters>> loadSpecificParameters(PlatformConfig config)

Reads implementation-specific parameters from platform config, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.

loadSpecificParameters

default Optional<Extension<ShortCircuitParameters>> loadSpecificParameters(Map<String,String> properties)

Reads implementation-specific parameters from a Map, or return Optional.empty() if the implementation does not have any specific parameters, or does not support loading from config.

updateSpecificParameters

default void updateSpecificParameters(Extension<ShortCircuitParameters> extension,
                                      Map<String,String> properties)

Updates implementation-specific parameters from a Map.

getSpecificParameters

default List<Parameter> getSpecificParameters()

Get the list of the specific parameters.