Package com.powsybl.contingency

Enum Class ContingencyContextType

java.lang.Object

java.lang.Enum<ContingencyContextType>

com.powsybl.contingency.ContingencyContextType

All Implemented Interfaces:

Serializable, Comparable<ContingencyContextType>, Constable

public enum ContingencyContextType
extends Enum<ContingencyContextType>

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>, Etienne Lesot <etienne.lesot at rte-france.com> Define for a contingencyContext the type of information asked. It can be a pre-contingency state, a post-contingency state (on a specific contingency (SPECIFIC) or on every contingency (ONLY_CONTINGENCIES)) or both (ALL)

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
ALL	Corresponds to all contingencies and pre-contingency situation
NONE	Corresponds to pre-contingency situation
ONLY_CONTINGENCIES	Corresponds to all contingencies (without the pre-contingency situation)
SPECIFIC	Corresponds to one contingency whose id is specified in the contingencyContext

Method Summary

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

ALL

public static final ContingencyContextType ALL

Corresponds to all contingencies and pre-contingency situation

NONE

public static final ContingencyContextType NONE

Corresponds to pre-contingency situation

SPECIFIC

public static final ContingencyContextType SPECIFIC

Corresponds to one contingency whose id is specified in the contingencyContext

ONLY_CONTINGENCIES

public static final ContingencyContextType ONLY_CONTINGENCIES

Corresponds to all contingencies (without the pre-contingency situation)

Method Details

values

public static ContingencyContextType[] 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 ContingencyContextType 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