Enum Class StateMachine.State
java.lang.Object
java.lang.Enum<StateMachine.State>
io.openems.edge.controller.ess.fixstateofcharge.statemachine.StateMachine.State
- All Implemented Interfaces:
OptionsEnum
,State<StateMachine.State>
,Serializable
,Comparable<StateMachine.State>
,Constable
- Enclosing class:
StateMachine
public static enum StateMachine.State
extends Enum<StateMachine.State>
implements State<StateMachine.State>, OptionsEnum
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionState if SoC is above configured target SoC.State if SoC equals to the configured target SoC.State if SoC is below configured target SoC.Controller is active, but not running (Property isRunning still false).State if the system is still waiting (LeftTime > ReqiredTime + Buffer).State if SoC is below configured target SoC but within boundaries.State if SoC is above configured target SoC but within boundaries. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Gets this enums String representation.Gets all the available States.Gets the enum that is used for 'UNDEFINED' values.int
getValue()
Gets this enums int representation.static StateMachine.State
Returns the enum constant of this class with the specified name.static StateMachine.State[]
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 interface io.openems.common.types.OptionsEnum
asCamelCase, isUndefined
-
Enum Constant Details
-
IDLE
Controller is active, but not running (Property isRunning still false). -
NOT_STARTED
State if the system is still waiting (LeftTime > ReqiredTime + Buffer). -
ABOVE_TARGET_SOC
State if SoC is above configured target SoC. -
BELOW_TARGET_SOC
State if SoC is below configured target SoC. -
AT_TARGET_SOC
State if SoC equals to the configured target SoC. -
WITHIN_LOWER_TARGET_SOC_BOUNDARIES
State if SoC is below configured target SoC but within boundaries. -
WITHIN_UPPER_TARGET_SOC_BOUNDARIES
State if SoC is above configured target SoC but within boundaries.
-
-
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
-
getValue
public int getValue()Description copied from interface:OptionsEnum
Gets this enums int representation.- Specified by:
getValue
in interfaceOptionsEnum
- Returns:
- the int representation
-
getName
Description copied from interface:OptionsEnum
Gets this enums String representation.- Specified by:
getName
in interfaceOptionsEnum
- Returns:
- the String representation
-
getUndefined
Description copied from interface:OptionsEnum
Gets the enum that is used for 'UNDEFINED' values.- Specified by:
getUndefined
in interfaceOptionsEnum
- Returns:
- the UNDEFINED enum
-
getStates
Description copied from interface:State
Gets all the available States.If used inside a 'State' enum, just implement this method using
@Override public State[] getStates() { return State.values(); }
- Specified by:
getStates
in interfaceState<StateMachine.State>
- Returns:
- an array of States, as provided by an enum.
-