Module com.powsybl.loadflow.api

Package com.powsybl.loadflow

Enum Class LoadFlowResult.ComponentResult.Status

java.lang.Object

java.lang.Enum<LoadFlowResult.ComponentResult.Status>

com.powsybl.loadflow.LoadFlowResult.ComponentResult.Status

All Implemented Interfaces:

Serializable, Comparable<LoadFlowResult.ComponentResult.Status>, Constable

Enclosing interface:

LoadFlowResult.ComponentResult

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

Component calculation 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
CONVERGED	Loadflow converged
FAILED	Non-convergence
MAX_ITERATION_REACHED	Non-convergence by iteration limit
NO_CALCULATION	Component was not calculated, e.g. de-energized component without any voltage support

Method Summary

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

CONVERGED

public static final LoadFlowResult.ComponentResult.Status CONVERGED

Loadflow converged

MAX_ITERATION_REACHED

public static final LoadFlowResult.ComponentResult.Status MAX_ITERATION_REACHED

Non-convergence by iteration limit

FAILED

public static final LoadFlowResult.ComponentResult.Status FAILED

Non-convergence

NO_CALCULATION

public static final LoadFlowResult.ComponentResult.Status NO_CALCULATION

Component was not calculated, e.g. de-energized component without any voltage support

Method Details

values

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