Package com.powsybl.sensitivity

Enum SensitivityFunctionType

java.lang.Object

java.lang.Enum<SensitivityFunctionType>

com.powsybl.sensitivity.SensitivityFunctionType

All Implemented Interfaces:

Serializable, Comparable<SensitivityFunctionType>

public enum SensitivityFunctionType
extends Enum<SensitivityFunctionType>

Supported function types related to the equipment to monitor. Use: - BRANCH_ACTIVE_POWER_1 and BRANCH_ACTIVE_POWER_2 if you want to monitor the active power in MW of a network branch (lines, two windings transformer, dangling lines, etc.). Use 1 for side 1 and 2 for side 2. In case of a three windings transformer, use BRANCH_ACTIVE_POWER_3 to monitor the active power in MW of the leg 3 (network side). - BRANCH_CURRENT_1 and BRANCH_CURRENT_2 if you want to monitor the current in A of a network branch (lines, two windings transformer, dangling lines, etc.). Use 1 for side 1 and use 2 for side 2. In case of a three windings transformer, use BRANCH_CURRENT_3 to monitor the current in A of the leg 3 (network side). - BUS_VOLTAGE if you want to monitor the voltage in KV of a specific network bus.

Author:

Geoffroy Jamgotchian

Enum Constant Summary

Enum Constants

Enum Constant	Description
BRANCH_ACTIVE_POWER	Deprecated. Use BRANCH_ACTIVE_POWER_1 instead.
BRANCH_ACTIVE_POWER_1
BRANCH_ACTIVE_POWER_2
BRANCH_ACTIVE_POWER_3
BRANCH_CURRENT	Deprecated. Use BRANCH_CURRENT_1 instead.
BRANCH_CURRENT_1
BRANCH_CURRENT_2
BRANCH_CURRENT_3
BUS_VOLTAGE

Method Summary

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

BRANCH_ACTIVE_POWER

@Deprecated
public static final SensitivityFunctionType BRANCH_ACTIVE_POWER

Deprecated.

Use BRANCH_ACTIVE_POWER_1 instead.

BRANCH_CURRENT

@Deprecated
public static final SensitivityFunctionType BRANCH_CURRENT

Deprecated.

Use BRANCH_CURRENT_1 instead.

BRANCH_ACTIVE_POWER_1

public static final SensitivityFunctionType BRANCH_ACTIVE_POWER_1

BRANCH_CURRENT_1

public static final SensitivityFunctionType BRANCH_CURRENT_1

BRANCH_ACTIVE_POWER_2

public static final SensitivityFunctionType BRANCH_ACTIVE_POWER_2

BRANCH_CURRENT_2

public static final SensitivityFunctionType BRANCH_CURRENT_2

BRANCH_ACTIVE_POWER_3

public static final SensitivityFunctionType BRANCH_ACTIVE_POWER_3

BRANCH_CURRENT_3

public static final SensitivityFunctionType BRANCH_CURRENT_3

BUS_VOLTAGE

public static final SensitivityFunctionType BUS_VOLTAGE

Method Detail

values

public static SensitivityFunctionType[] 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 (SensitivityFunctionType c : SensitivityFunctionType.values())
    System.out.println(c);

Returns:

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

valueOf

public static SensitivityFunctionType valueOf(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:

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

NullPointerException - if the argument is null