Package com.powsybl.loadflow

Enum Class LoadFlowResult.Status

java.lang.Object

java.lang.Enum<LoadFlowResult.Status>

com.powsybl.loadflow.LoadFlowResult.Status

All Implemented Interfaces:

Serializable, Comparable<LoadFlowResult.Status>, Constable

Enclosing interface:

LoadFlowResult

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

Load Flow global calculation status, derived from all LoadFlowResult.ComponentResult, using LoadFlowResult.ComponentResult.Status, but excluding non-calculated component i.e. excluding components having status NO_CALCULATION

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
FAILED	No single component has status CONVERGED.
FULLY_CONVERGED	All calculated components have status CONVERGED and there is at least one CONVERGED component.
PARTIALLY_CONVERGED	At least one component has status CONVERGED, but some others have status FAILED or MAX_ITERATION_REACHED

Method Summary

Modifier and Type	Method	Description
static LoadFlowResult.Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LoadFlowResult.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

FULLY_CONVERGED

public static final LoadFlowResult.Status FULLY_CONVERGED

All calculated components have status CONVERGED and there is at least one CONVERGED component.

PARTIALLY_CONVERGED

public static final LoadFlowResult.Status PARTIALLY_CONVERGED

At least one component has status CONVERGED, but some others have status FAILED or MAX_ITERATION_REACHED

FAILED

public static final LoadFlowResult.Status FAILED

No single component has status CONVERGED. I.e. all components have either status FAILED or MAX_ITERATION_REACHED or NO_CALCULATION

Method Details

values

public static LoadFlowResult.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 LoadFlowResult.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