Package com.powsybl.iidm.network

Enum Class TopologyLevel

java.lang.Object

java.lang.Enum<TopologyLevel>

com.powsybl.iidm.network.TopologyLevel

All Implemented Interfaces:

Serializable, Comparable<TopologyLevel>, Constable

public enum TopologyLevel
extends Enum<TopologyLevel>

The level of topology.

Author:

Teofil Calin BANC <teofil-calin.banc at rte-france.com>

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
BUS_BRANCH
BUS_BREAKER
NODE_BREAKER

Method Summary

Modifier and Type	Method	Description
TopologyKind	getTopologyKind()
static TopologyLevel	min(TopologyKind topologyKind, TopologyLevel topologyLevel)	Return the least detailed topology level between a TopologyKind and a TopologyLevel
static TopologyLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TopologyLevel[]	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

NODE_BREAKER

public static final TopologyLevel NODE_BREAKER

BUS_BREAKER

public static final TopologyLevel BUS_BREAKER

BUS_BRANCH

public static final TopologyLevel BUS_BRANCH

Method Details

values

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

getTopologyKind

public TopologyKind getTopologyKind()

min

public static TopologyLevel min(TopologyKind topologyKind,
 TopologyLevel topologyLevel)

Return the least detailed topology level between a TopologyKind and a TopologyLevel