com.powsybl.iidm.network

Enum TopologyLevel

java.lang.Object

java.lang.Enum<TopologyLevel>

com.powsybl.iidm.network.TopologyLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TopologyLevel>

public enum TopologyLevel
extends java.lang.Enum<TopologyLevel>

The level of topology.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUS_BRANCH
BUS_BREAKER
NODE_BREAKER

Method Summary

Modifier and Type	Method and 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(java.lang.String name) Returns the enum constant of this type with the specified name.
static TopologyLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static TopologyLevel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TopologyLevel c : TopologyLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static TopologyLevel valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.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