Package com.powsybl.shortcircuit

Class FaultParameters

java.lang.Object

com.powsybl.shortcircuit.FaultParameters

public class FaultParameters
extends Object

Author:

Thomas Adam

Constructor Summary

Constructors

Constructor	Description
FaultParameters(String id, boolean withLimitViolations, boolean withVoltageMap, boolean withFeederResult, StudyType studyType, double minVoltageDropProportionalThreshold)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getId()	Fault id
double	getMinVoltageDropProportionalThreshold()	Override general parameter minVoltageDropProportionalThreshold from ShortCircuitParameters
StudyType	getStudyType()	Override general parameter studyType from ShortCircuitParameters
int	hashCode()
boolean	isWithFeederResult()	Override general parameter withFeederResult from ShortCircuitParameters
boolean	isWithLimitViolations()	Whether the result should indicate a limit violation
boolean	isWithVoltageMap()	Whether the results should include the voltage map on the whole network
static List<FaultParameters>	read(Path jsonFile)
String	toString()
static void	write(List<FaultParameters> parameters, Path jsonFile)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FaultParameters

public FaultParameters(String id,
                       boolean withLimitViolations,
                       boolean withVoltageMap,
                       boolean withFeederResult,
                       StudyType studyType,
                       double minVoltageDropProportionalThreshold)

Method Detail

getId

public String getId()

Fault id

isWithLimitViolations

public boolean isWithLimitViolations()

Whether the result should indicate a limit violation

isWithVoltageMap

public boolean isWithVoltageMap()

Whether the results should include the voltage map on the whole network

isWithFeederResult

public boolean isWithFeederResult()

Override general parameter withFeederResult from ShortCircuitParameters

getStudyType

public StudyType getStudyType()

Override general parameter studyType from ShortCircuitParameters

getMinVoltageDropProportionalThreshold

public double getMinVoltageDropProportionalThreshold()

Override general parameter minVoltageDropProportionalThreshold from ShortCircuitParameters

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

write

public static void write(List<FaultParameters> parameters,
                         Path jsonFile)

read

public static List<FaultParameters> read(Path jsonFile)