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 of SecurityAnalysisProvider: several variants of synchronous and asynchronous run with default parameters.

Method Summary

Modifier and Type	Method	Description
static SecurityAnalysis.Runner	find()	Get a runner for default security analysis implementation.
static SecurityAnalysis.Runner	find(String name)	Get a runner for security analysis implementation named name.
static SecurityAnalysisReport	run(Network network, ContingenciesProvider contingenciesProvider, SecurityAnalysisParameters parameters, ComputationManager computationManager)
static SecurityAnalysisReport	run(Network network, ContingenciesProvider contingenciesProvider, SecurityAnalysisParameters parameters, ComputationManager computationManager, LimitViolationFilter filter)
static SecurityAnalysisReport	run(Network network, String workingStateId, ContingenciesProvider contingenciesProvider, SecurityAnalysisParameters parameters, ComputationManager computationManager, LimitViolationFilter filter, LimitViolationDetector detector, List<SecurityAnalysisInterceptor> interceptors, List<OperatorStrategy> operatorStrategies, List<Action> actions)
static SecurityAnalysisReport	run(Network network, String workingStateId, ContingenciesProvider contingenciesProvider, SecurityAnalysisParameters parameters, ComputationManager computationManager, LimitViolationFilter filter, LimitViolationDetector detector, List<SecurityAnalysisInterceptor> interceptors, List<OperatorStrategy> operatorStrategies, List<Action> actions, List<StateMonitor> monitors, Reporter reporter)
static SecurityAnalysisReport	run(Network network, List<Contingency> contingencies)
static SecurityAnalysisReport	run(Network network, List<Contingency> contingencies, SecurityAnalysisParameters parameters)
static CompletableFuture<SecurityAnalysisReport>	runAsync(Network network, ContingenciesProvider contingenciesProvider, SecurityAnalysisParameters parameters, ComputationManager computationManager)
static CompletableFuture<SecurityAnalysisReport>	runAsync(Network network, ContingenciesProvider contingenciesProvider, SecurityAnalysisParameters parameters, ComputationManager computationManager, LimitViolationFilter filter)
static CompletableFuture<SecurityAnalysisReport>	runAsync(Network network, String workingStateId, ContingenciesProvider contingenciesProvider, SecurityAnalysisParameters parameters, ComputationManager computationManager, LimitViolationFilter filter, LimitViolationDetector detector, List<SecurityAnalysisInterceptor> interceptors, List<OperatorStrategy> operatorStrategies, List<Action> actions, Reporter reporter)
static CompletableFuture<SecurityAnalysisReport>	runAsync(Network network, List<Contingency> contingencies)
static CompletableFuture<SecurityAnalysisReport>	runAsync(Network network, List<Contingency> contingencies, SecurityAnalysisParameters parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

find

public static SecurityAnalysis.Runner find(String name)

Get a runner for security analysis implementation named name. In the case of a null name, 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,
                                                                 ContingenciesProvider contingenciesProvider,
                                                                 SecurityAnalysisParameters parameters,
                                                                 ComputationManager computationManager,
                                                                 LimitViolationFilter filter,
                                                                 LimitViolationDetector detector,
                                                                 List<SecurityAnalysisInterceptor> interceptors,
                                                                 List<OperatorStrategy> operatorStrategies,
                                                                 List<Action> actions,
                                                                 Reporter reporter)

runAsync

public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network,
                                                                 ContingenciesProvider contingenciesProvider,
                                                                 SecurityAnalysisParameters parameters,
                                                                 ComputationManager computationManager,
                                                                 LimitViolationFilter filter)

runAsync

public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network,
                                                                 ContingenciesProvider contingenciesProvider,
                                                                 SecurityAnalysisParameters parameters,
                                                                 ComputationManager computationManager)

runAsync

public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network,
                                                                 List<Contingency> contingencies,
                                                                 SecurityAnalysisParameters parameters)

runAsync

public static CompletableFuture<SecurityAnalysisReport> runAsync(Network network,
                                                                 List<Contingency> contingencies)

run

public static SecurityAnalysisReport run(Network network,
                                         String workingStateId,
                                         ContingenciesProvider contingenciesProvider,
                                         SecurityAnalysisParameters parameters,
                                         ComputationManager computationManager,
                                         LimitViolationFilter filter,
                                         LimitViolationDetector detector,
                                         List<SecurityAnalysisInterceptor> interceptors,
                                         List<OperatorStrategy> operatorStrategies,
                                         List<Action> actions)

run

public static SecurityAnalysisReport run(Network network,
                                         String workingStateId,
                                         ContingenciesProvider contingenciesProvider,
                                         SecurityAnalysisParameters parameters,
                                         ComputationManager computationManager,
                                         LimitViolationFilter filter,
                                         LimitViolationDetector detector,
                                         List<SecurityAnalysisInterceptor> interceptors,
                                         List<OperatorStrategy> operatorStrategies,
                                         List<Action> actions,
                                         List<StateMonitor> monitors,
                                         Reporter reporter)

run

public static SecurityAnalysisReport run(Network network,
                                         ContingenciesProvider contingenciesProvider,
                                         SecurityAnalysisParameters parameters,
                                         ComputationManager computationManager,
                                         LimitViolationFilter filter)

run

public static SecurityAnalysisReport run(Network network,
                                         ContingenciesProvider contingenciesProvider,
                                         SecurityAnalysisParameters parameters,
                                         ComputationManager computationManager)

run

public static SecurityAnalysisReport run(Network network,
                                         List<Contingency> contingencies,
                                         SecurityAnalysisParameters parameters)

run

public static SecurityAnalysisReport run(Network network,
                                         List<Contingency> contingencies)