com.powsybl.security.execution

Class SecurityAnalysisExecutionInput

java.lang.Object

com.powsybl.security.execution.SecurityAnalysisExecutionInput

public class SecurityAnalysisExecutionInput
extends java.lang.Object

Arguments for a SecurityAnalysisExecution :

• a Network and the variant to be considered
• some SecurityAnalysisParameters
• a set of requested result extensions
• the set of violation types to be considered
• an optional ByteSource which describes contingencies

Design note: here we only want serializable objects for forwarding purpose, therefore some fields are fully serializable business objects while others are more in their "source" format as they do not support serialization out of the box.

Constructor Summary

Constructors

Constructor and Description
SecurityAnalysisExecutionInput()

Method Summary

Modifier and Type	Method and Description
SecurityAnalysisExecutionInput	addResultExtension(java.lang.String resultExtension)
SecurityAnalysisExecutionInput	addResultExtensions(java.util.Collection<java.lang.String> resultExtensions)
SecurityAnalysisExecutionInput	addViolationType(LimitViolationType violationType)
SecurityAnalysisExecutionInput	addViolationTypes(java.util.Collection<LimitViolationType> violationTypes)
java.util.Optional<com.google.common.io.ByteSource>	getContingenciesSource()
NetworkVariant	getNetworkVariant()
SecurityAnalysisParameters	getParameters()
java.util.List<java.lang.String>	getResultExtensions()
java.util.Set<LimitViolationType>	getViolationTypes()
SecurityAnalysisExecutionInput	setContingenciesSource(com.google.common.io.ByteSource contingenciesSource)
SecurityAnalysisExecutionInput	setNetworkVariant(Network network, java.lang.String variantId)
SecurityAnalysisExecutionInput	setParameters(SecurityAnalysisParameters parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityAnalysisExecutionInput

public SecurityAnalysisExecutionInput()

Method Detail

getContingenciesSource

public java.util.Optional<com.google.common.io.ByteSource> getContingenciesSource()

getResultExtensions

public java.util.List<java.lang.String> getResultExtensions()

getViolationTypes

public java.util.Set<LimitViolationType> getViolationTypes()

getParameters

public SecurityAnalysisParameters getParameters()

getNetworkVariant

public NetworkVariant getNetworkVariant()

setContingenciesSource

public SecurityAnalysisExecutionInput setContingenciesSource(com.google.common.io.ByteSource contingenciesSource)

addResultExtension

public SecurityAnalysisExecutionInput addResultExtension(java.lang.String resultExtension)

addResultExtensions

public SecurityAnalysisExecutionInput addResultExtensions(java.util.Collection<java.lang.String> resultExtensions)

addViolationType

public SecurityAnalysisExecutionInput addViolationType(LimitViolationType violationType)

addViolationTypes

public SecurityAnalysisExecutionInput addViolationTypes(java.util.Collection<LimitViolationType> violationTypes)

setParameters

public SecurityAnalysisExecutionInput setParameters(SecurityAnalysisParameters parameters)

setNetworkVariant

public SecurityAnalysisExecutionInput setNetworkVariant(Network network,
                                                        java.lang.String variantId)