Package com.powsybl.security
Class SecurityAnalysisResultBuilder
java.lang.Object
com.powsybl.security.SecurityAnalysisResultBuilder
Facilitates the creation of security analysis results.
Encapsulates filtering of limit violations with a provided LimitViolationFilter
,
as well as notifications to SecurityAnalysisInterceptor
s.
- Author:
- Sylvain Leclerc <sylvain.leclerc at rte-france.com>
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
SecurityAnalysisResultBuilder.AbstractLimitViolationsResultBuilder<B extends SecurityAnalysisResultBuilder.AbstractLimitViolationsResultBuilder<B>>
Base class for the pre and post contingency builders.class
class
class
Builder for the pre-contingency result -
Constructor Summary
ConstructorDescriptionSecurityAnalysisResultBuilder
(LimitViolationFilter filter, SecurityAnalysisResultContext context, Collection<SecurityAnalysisInterceptor> interceptors) -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Finalizes the result.contingency
(Contingency contingency) Initiates the creation of the result for oneContingency
.contingency
(Contingency contingency, SecurityAnalysisResultContext postContingencyResultContext) Initiates the creation of the result for oneContingency
operatorStrategy
(OperatorStrategy strategy) Initiates the creation of the result for oneOperatorStrategy
.operatorStrategy
(OperatorStrategy strategy, SecurityAnalysisResultContext strategyContext) Initiates the creation of the result for oneOperatorStrategy
.Initiates the creation of the result for N situation.preContingency
(SecurityAnalysisResultContext preContingencyResultContext) Initiates the creation of the result for N situation
-
Constructor Details
-
SecurityAnalysisResultBuilder
public SecurityAnalysisResultBuilder(LimitViolationFilter filter, SecurityAnalysisResultContext context, Collection<SecurityAnalysisInterceptor> interceptors) -
SecurityAnalysisResultBuilder
public SecurityAnalysisResultBuilder(LimitViolationFilter filter, SecurityAnalysisResultContext context)
-
-
Method Details
-
preContingency
Initiates the creation of the result for N situation.- Returns:
- a
SecurityAnalysisResultBuilder.PreContingencyResultBuilder
instance.
-
preContingency
public SecurityAnalysisResultBuilder.PreContingencyResultBuilder preContingency(SecurityAnalysisResultContext preContingencyResultContext) Initiates the creation of the result for N situation- Parameters:
preContingencyResultContext
- the context used when create the result- Returns:
- a
SecurityAnalysisResultBuilder.PreContingencyResultBuilder
instance.
-
contingency
public SecurityAnalysisResultBuilder.PostContingencyResultBuilder contingency(Contingency contingency) Initiates the creation of the result for oneContingency
.- Parameters:
contingency
- the contingency for which a result should be created- Returns:
- a
SecurityAnalysisResultBuilder.PostContingencyResultBuilder
instance.
-
contingency
public SecurityAnalysisResultBuilder.PostContingencyResultBuilder contingency(Contingency contingency, SecurityAnalysisResultContext postContingencyResultContext) Initiates the creation of the result for oneContingency
- Parameters:
contingency
- the contingency for which a result should be createdpostContingencyResultContext
- the context used when create the result- Returns:
- a
SecurityAnalysisResultBuilder.PostContingencyResultBuilder
instance.
-
operatorStrategy
public SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder operatorStrategy(OperatorStrategy strategy) Initiates the creation of the result for oneOperatorStrategy
.- Parameters:
strategy
- the operator strategy for which a result should be created- Returns:
- a
SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder
instance.
-
operatorStrategy
public SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder operatorStrategy(OperatorStrategy strategy, SecurityAnalysisResultContext strategyContext) Initiates the creation of the result for oneOperatorStrategy
.- Parameters:
strategy
- the operator strategy for which a result should be created- Returns:
- a
SecurityAnalysisResultBuilder.OperatorStrategyResultBuilder
instance.
-
build
Finalizes the result.- Returns:
- the N situation result builder
-