Package io.openems.edge.evcs.api

Enum Class Phases

java.lang.Object

java.lang.Enum<Phases>

io.openems.edge.evcs.api.Phases

All Implemented Interfaces:

OptionsEnum, Serializable, Comparable<Phases>, Constable

public enum Phases
extends Enum<Phases>
implements OptionsEnum

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
ONE_PHASE
THREE_PHASE
TWO_PHASE

Method Summary

Modifier and Type	Method	Description
int	getFromThreePhase(int threePhaseValue)	Get value converted from a three phase value.
String	getName()	Gets this enums String representation.
OptionsEnum	getUndefined()	Gets the enum that is used for 'UNDEFINED' values.
int	getValue()	Gets this enums int representation.
static Phases	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Phases[]	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

Methods inherited from interface io.openems.common.types.OptionsEnum

asCamelCase, isUndefined

Enum Constant Details

ONE_PHASE

public static final Phases ONE_PHASE

TWO_PHASE

public static final Phases TWO_PHASE

THREE_PHASE

public static final Phases THREE_PHASE

Method Details

values

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

getValue

public int getValue()

Description copied from interface: OptionsEnum

Gets this enums int representation.

Specified by:

getValue in interface OptionsEnum

Returns:

the int representation

getName

public String getName()

Description copied from interface: OptionsEnum

Gets this enums String representation.

Specified by:

getName in interface OptionsEnum

Returns:

the String representation

getFromThreePhase

public int getFromThreePhase(int threePhaseValue)

Get value converted from a three phase value.

As the values e.g. hardware limit are most likely given for three phase charging, this is used to convert the value, depending on the current phases

Parameters:

threePhaseValue - value using all three phases as power

Returns:

converted value

getUndefined

public OptionsEnum getUndefined()

Description copied from interface: OptionsEnum

Gets the enum that is used for 'UNDEFINED' values.

Specified by:

getUndefined in interface OptionsEnum

Returns:

the UNDEFINED enum