Enum Class Scalable.ScalingConvention
java.lang.Object
java.lang.Enum<Scalable.ScalingConvention>
com.powsybl.iidm.modification.scalable.Scalable.ScalingConvention
- All Implemented Interfaces:
Serializable
,Comparable<Scalable.ScalingConvention>
,Constable
- Enclosing interface:
- Scalable
Sign convention usable for scaling.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionGenerator convention means that a positive scale will imply an increase of generators target power and a decrease of load consumption.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 TypeMethodDescriptionstatic Scalable.ScalingConvention
Returns the enum constant of this class with the specified name.static Scalable.ScalingConvention[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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 Details
-
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
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 nameNullPointerException
- if the argument is null
-