Package com.powsybl.shortcircuit

Enum Class FaultResult.Status

java.lang.Object

java.lang.Enum<FaultResult.Status>

com.powsybl.shortcircuit.FaultResult.Status

All Implemented Interfaces:

Serializable, Comparable<FaultResult.Status>, Constable

Enclosing interface:

FaultResult

public static enum FaultResult.Status
extends Enum<FaultResult.Status>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILURE	The computation failed due to something not related to the solver.
NO_SHORT_CIRCUIT_DATA	Data useful to short-circuit current calculation is missing, typically the transient reactance of generators
SOLVER_FAILURE	The computation failed due to an error in the solver.
SUCCESS	The computation went ok and no error were returned

Method Summary

Modifier and Type	Method	Description
static FaultResult.Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FaultResult.Status[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final FaultResult.Status SUCCESS

The computation went ok and no error were returned

NO_SHORT_CIRCUIT_DATA

public static final FaultResult.Status NO_SHORT_CIRCUIT_DATA

Data useful to short-circuit current calculation is missing, typically the transient reactance of generators

SOLVER_FAILURE

public static final FaultResult.Status SOLVER_FAILURE

The computation failed due to an error in the solver.

FAILURE

public static final FaultResult.Status FAILURE

The computation failed due to something not related to the solver.

Method Details

values

public static FaultResult.Status[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FaultResult.Status valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null