Package com.powsybl.shortcircuit

Class ShortCircuitParameters

java.lang.Object

com.powsybl.commons.extensions.AbstractExtendable<ShortCircuitParameters>

com.powsybl.shortcircuit.ShortCircuitParameters

All Implemented Interfaces:

Extendable<ShortCircuitParameters>

public class ShortCircuitParameters
extends AbstractExtendable<ShortCircuitParameters>

Generic parameters for short circuit-computations. May contain extensions for implementation-specific parameters.

Author:

Boubakeur Brahimi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShortCircuitParameters.ConfigLoader<E extends Extension<ShortCircuitParameters>>

Field Summary

Fields

Modifier and Type	Field	Description
static String	VERSION

Constructor Summary

Constructors

Constructor	Description
ShortCircuitParameters()

Method Summary

Modifier and Type	Method	Description
double	getMinVoltageDropProportionalThreshold()	The maximum voltage drop threshold in %.
StudyType	getStudyType()
boolean	isWithFeederResult()
boolean	isWithLimitViolations()
boolean	isWithVoltageMap()
static ShortCircuitParameters	load()	Load parameters from platform default config.
static ShortCircuitParameters	load(PlatformConfig platformConfig)
ShortCircuitParameters	setMinVoltageDropProportionalThreshold(double minVoltageDropProportionalThreshold)
ShortCircuitParameters	setStudyType(StudyType studyType)
ShortCircuitParameters	setWithFeederResult(boolean withFeederResult)
ShortCircuitParameters	setWithLimitViolations(boolean withLimitViolations)
ShortCircuitParameters	setWithVoltageMap(boolean withVoltageMap)

Methods inherited from class com.powsybl.commons.extensions.AbstractExtendable

addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, removeExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.commons.extensions.Extendable

newExtension

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

ShortCircuitParameters

public ShortCircuitParameters()

Method Detail

load

public static ShortCircuitParameters load()

Load parameters from platform default config.

load

public static ShortCircuitParameters load(PlatformConfig platformConfig)

isWithLimitViolations

public boolean isWithLimitViolations()

setWithLimitViolations

public ShortCircuitParameters setWithLimitViolations(boolean withLimitViolations)

isWithVoltageMap

public boolean isWithVoltageMap()

setWithVoltageMap

public ShortCircuitParameters setWithVoltageMap(boolean withVoltageMap)

isWithFeederResult

public boolean isWithFeederResult()

setWithFeederResult

public ShortCircuitParameters setWithFeederResult(boolean withFeederResult)

getStudyType

public StudyType getStudyType()

setStudyType

public ShortCircuitParameters setStudyType(StudyType studyType)

getMinVoltageDropProportionalThreshold

public double getMinVoltageDropProportionalThreshold()

The maximum voltage drop threshold in %.

setMinVoltageDropProportionalThreshold

public ShortCircuitParameters setMinVoltageDropProportionalThreshold(double minVoltageDropProportionalThreshold)