Package com.powsybl.ampl.converter

Enum Class AmplReadableElement

java.lang.Object

java.lang.Enum<AmplReadableElement>

com.powsybl.ampl.converter.AmplReadableElement

All Implemented Interfaces:

Serializable, Comparable<AmplReadableElement>, Constable

public enum AmplReadableElement
extends Enum<AmplReadableElement>

This enum maps elements to their reading function in AmplNetworkReader

Author:

Nicolas Pierre < [email protected] >

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
BATTERY
BRANCH
BUS
GENERATOR
HVDCLINE
LCC_CONVERTER_STATION
LOAD
PHASE_TAP_CHANGER
RATIO_TAP_CHANGER
SHUNT
STATIC_VAR_COMPENSATOR
VSC_CONVERTER_STATION

Method Summary

Modifier and Type	Method	Description
void	readElement(AmplNetworkReader reader)
static AmplReadableElement	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AmplReadableElement[]	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

BATTERY

public static final AmplReadableElement BATTERY

BUS

public static final AmplReadableElement BUS

BRANCH

public static final AmplReadableElement BRANCH

GENERATOR

public static final AmplReadableElement GENERATOR

HVDCLINE

public static final AmplReadableElement HVDCLINE

LCC_CONVERTER_STATION

public static final AmplReadableElement LCC_CONVERTER_STATION

LOAD

public static final AmplReadableElement LOAD

PHASE_TAP_CHANGER

public static final AmplReadableElement PHASE_TAP_CHANGER

RATIO_TAP_CHANGER

public static final AmplReadableElement RATIO_TAP_CHANGER

SHUNT

public static final AmplReadableElement SHUNT

STATIC_VAR_COMPENSATOR

public static final AmplReadableElement STATIC_VAR_COMPENSATOR

VSC_CONVERTER_STATION

public static final AmplReadableElement VSC_CONVERTER_STATION

Method Details

values

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

readElement

public void readElement(AmplNetworkReader reader)
                 throws IOException

Throws:

IOException