Package io.openems.edge.ess.generic.offgrid.statemachine

Enum Class StateMachine.OffGridState

java.lang.Object

java.lang.Enum<StateMachine.OffGridState>

io.openems.edge.ess.generic.offgrid.statemachine.StateMachine.OffGridState

All Implemented Interfaces:

OptionsEnum, State<StateMachine.OffGridState>, Serializable, Comparable<StateMachine.OffGridState>, Constable

Enclosing class:

StateMachine

public static enum StateMachine.OffGridState
extends Enum<StateMachine.OffGridState>
implements State<StateMachine.OffGridState>, 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
ERROR
GRID_SWITCH
START_BATTERY_IN_OFF_GRID
START_BATTERY_IN_ON_GRID
START_BATTERY_INVERTER_IN_OFF_GRID
START_BATTERY_INVERTER_IN_ON_GRID
STARTED_IN_OFF_GRID
STARTED_IN_ON_GRID
STOP_BATTERY
STOP_BATTERY_INVERTER
STOPPED
UNDEFINED

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets this enums String representation.
StateMachine.OffGridState[]	getStates()	Gets all the available States.
OptionsEnum	getUndefined()	Gets the enum that is used for 'UNDEFINED' values.
int	getValue()	Gets this enums int representation.
static StateMachine.OffGridState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StateMachine.OffGridState[]	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

UNDEFINED

public static final StateMachine.OffGridState UNDEFINED

START_BATTERY_IN_ON_GRID

public static final StateMachine.OffGridState START_BATTERY_IN_ON_GRID

START_BATTERY_INVERTER_IN_ON_GRID

public static final StateMachine.OffGridState START_BATTERY_INVERTER_IN_ON_GRID

STARTED_IN_ON_GRID

public static final StateMachine.OffGridState STARTED_IN_ON_GRID

START_BATTERY_IN_OFF_GRID

public static final StateMachine.OffGridState START_BATTERY_IN_OFF_GRID

START_BATTERY_INVERTER_IN_OFF_GRID

public static final StateMachine.OffGridState START_BATTERY_INVERTER_IN_OFF_GRID

STARTED_IN_OFF_GRID

public static final StateMachine.OffGridState STARTED_IN_OFF_GRID

STOP_BATTERY_INVERTER

public static final StateMachine.OffGridState STOP_BATTERY_INVERTER

STOP_BATTERY

public static final StateMachine.OffGridState STOP_BATTERY

STOPPED

public static final StateMachine.OffGridState STOPPED

GRID_SWITCH

public static final StateMachine.OffGridState GRID_SWITCH

ERROR

public static final StateMachine.OffGridState ERROR

Method Details

values

public static StateMachine.OffGridState[] 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 StateMachine.OffGridState 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

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

getStates

public StateMachine.OffGridState[] 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 interface State<StateMachine.OffGridState>

Returns:

an array of States, as provided by an enum.