Interface SecurityAnalysisInterceptor
- All Known Implementing Classes:
CurrentLimitViolationInterceptor
,DefaultSecurityAnalysisInterceptor
public interface SecurityAnalysisInterceptor
Security analysis interceptors are notified at various steps of the construction of
the
SecurityAnalysisResult
, for instance when adding new limit violations
.
This mechanism allows for example users of the SecurityAnalysis
to add
additional information in the result, as extensions
.
Some of this information can be retrieved from the provided SecurityAnalysisResultContext
.
Implementations of the security analysis can provide implementation-specific information by providing
their own implementation of this context.
Note that the contexts provided to the various methods can be different objects, in order to provide more specific information, for example for violations or contingencies. This can also be helpful to guarantee thread safety, if the result builder is used concurrently.
- Author:
- Mathieu Bague <mathieu.bague at rte-france.com>
-
Method Summary
Modifier and TypeMethodDescriptionvoid
onLimitViolation
(Contingency contingency, LimitViolation limitViolation, SecurityAnalysisResultContext context) Callback when a violation is detected on N-1 situation.void
onLimitViolation
(LimitViolation limitViolation, SecurityAnalysisResultContext context) Callback when a violation is detected on N situation.void
onPostContingencyResult
(PostContingencyResult postContingencyResult, SecurityAnalysisResultContext context) Callback after the post-contingency result is built.void
onPreContingencyResult
(PreContingencyResult preContingencyResult, SecurityAnalysisResultContext context) Callback after the pre-contingency result is built.void
onSecurityAnalysisResult
(SecurityAnalysisResult result, SecurityAnalysisResultContext context) Callback after the security-analysis result is built.
-
Method Details
-
onPreContingencyResult
void onPreContingencyResult(PreContingencyResult preContingencyResult, SecurityAnalysisResultContext context) Callback after the pre-contingency result is built.- Parameters:
preContingencyResult
-context
-
-
onPostContingencyResult
void onPostContingencyResult(PostContingencyResult postContingencyResult, SecurityAnalysisResultContext context) Callback after the post-contingency result is built.- Parameters:
context
-postContingencyResult
-
-
onSecurityAnalysisResult
Callback after the security-analysis result is built.- Parameters:
result
-context
-
-
onLimitViolation
Callback when a violation is detected on N situation.- Parameters:
limitViolation
-context
-
-
onLimitViolation
void onLimitViolation(Contingency contingency, LimitViolation limitViolation, SecurityAnalysisResultContext context) Callback when a violation is detected on N-1 situation.- Parameters:
contingency
-limitViolation
-context
-
-