Package com.powsybl.iidm.modification.scalable

Enum Scalable.ScalingConvention

java.lang.Object

java.lang.Enum<Scalable.ScalingConvention>

com.powsybl.iidm.modification.scalable.Scalable.ScalingConvention

All Implemented Interfaces:

Serializable, Comparable<Scalable.ScalingConvention>

Enclosing interface:

Scalable

public static enum Scalable.ScalingConvention
extends Enum<Scalable.ScalingConvention>

Sign convention usable for scaling.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GENERATOR	Generator convention means that a positive scale will imply an increase of generators target power and a decrease of load consumption.
LOAD	Load convention means that a positive scale will imply a decrease of generators target power and an increase of load consumption.

Method Summary

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

GENERATOR

public static final Scalable.ScalingConvention GENERATOR

Generator convention means that a positive scale will imply an increase of generators target power and a decrease of load consumption.

LOAD

public static final Scalable.ScalingConvention LOAD

Load convention means that a positive scale will imply a decrease of generators target power and an increase of load consumption.

Method Detail

values

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

Returns:

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

valueOf

public static Scalable.ScalingConvention 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