Package com.powsybl.security
Class SecurityAnalysis
- java.lang.Object
-
- com.powsybl.security.SecurityAnalysis
-
public final class SecurityAnalysis extends Object
Security analysis main API. It is a utility class (so with only static methods) used as an entry point for running a security analysis allowing to choose either a specific implementation or just to rely on the default one.- Author:
- Thomas Adam
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SecurityAnalysis.Runner
A security analysis runner is responsible for providing convenient methods on top ofSecurityAnalysisProvider
: several variants of synchronous and asynchronous run with default parameters.
-
Method Summary
-
-
-
Method Detail
-
find
public static SecurityAnalysis.Runner find(String name)
Get a runner for security analysis implementation namedname
. In the case of a nullname
, default implementation is used.- Parameters:
name
- name of the security analysis implementation, null if we want to use default one- Returns:
- a runner for security analysis implementation named
name
-
find
public static SecurityAnalysis.Runner find()
Get a runner for default security analysis implementation.- Returns:
- a runner for default security analysis implementation
- Throws:
PowsyblException
- in case we cannot find a default implementation
-
runAsync
public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network, String workingStateId, LimitViolationDetector detector, LimitViolationFilter filter, ComputationManager computationManager, SecurityAnalysisParameters parameters, ContingenciesProvider contingenciesProvider, List<SecurityAnalysisInterceptor> interceptors)
-
runAsync
public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network, LimitViolationFilter filter, ComputationManager computationManager)
-
runAsync
public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network, ComputationManager computationManager)
-
runAsync
public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network)
-
run
public static SecurityAnalysisReport run(Network network, String workingStateId, LimitViolationDetector detector, LimitViolationFilter filter, ComputationManager computationManager, SecurityAnalysisParameters parameters, ContingenciesProvider contingenciesProvider, List<SecurityAnalysisInterceptor> interceptors)
-
run
public static SecurityAnalysisReport run(Network network, String workingStateId, LimitViolationDetector detector, LimitViolationFilter filter, ComputationManager computationManager, SecurityAnalysisParameters parameters, ContingenciesProvider contingenciesProvider, List<SecurityAnalysisInterceptor> interceptors, List<StateMonitor> monitors)
-
run
public static SecurityAnalysisReport run(Network network, LimitViolationFilter filter, ComputationManager computationManager)
-
run
public static SecurityAnalysisReport run(Network network, ComputationManager computationManager)
-
run
public static SecurityAnalysisReport run(Network network)
-
-