Package com.powsybl.shortcircuit
Interface ShortCircuitAnalysisProvider
- All Superinterfaces:
PlatformConfigNamedProvider
,Versionable
Computation results are provided asynchronously as a ShortCircuitAnalysisResult
.
Implementations of that interface may typically rely on an external tool.
- Author:
- Anne Tilloy <anne.tilloy at rte-france.com>
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.powsybl.commons.config.PlatformConfigNamedProvider
PlatformConfigNamedProvider.Finder
-
Method Summary
Modifier and TypeMethodDescriptionstatic List<ShortCircuitAnalysisProvider>
findAll()
Get the list of the specific parameters.default Optional<ExtensionJsonSerializer>
The serializer for implementation-specific parameters, orOptional.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 returnOptional.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 returnOptional.empty()
if the implementation does not have any specific parameters, or does not support loading from config.run
(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters) Run an asynchronous single short circuit analysis job.run
(Network network, List<Fault> faults, ShortCircuitParameters parameters, ComputationManager computationManager, List<FaultParameters> faultParameters, ReportNode reportNode) 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 Details
-
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, ReportNode reportNode) Run an asynchronous single short circuit analysis job. -
getSpecificParametersSerializer
The serializer for implementation-specific parameters, orOptional.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>
whereMyParametersExtension
is the specific parameters class. -
loadSpecificParameters
Reads implementation-specific parameters from platform config, or returnOptional.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 returnOptional.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
Get the list of the specific parameters.
-