Package io.openems.edge.common.startstop

Enum Class StartStopConfig

java.lang.Object

java.lang.Enum<StartStopConfig>

io.openems.edge.common.startstop.StartStopConfig

All Implemented Interfaces:

Serializable, Comparable<StartStopConfig>, Constable

public enum StartStopConfig
extends Enum<StartStopConfig>

Every OpenEMS Component that implements StartStoppable is required to have a configuration property "startStop" of this type that overrides the logic of the StartStoppable.setStartStop(StartStop) method:.

        @AttributeDefinition(name = "Start/stop behaviour?", description = "Should this Component be forced to start or stop?")
        StartStopConfig startStop() default StartStopConfig.AUTO;
 

• if config is START -> always start
• if config is STOP -> always stop
• if config is AUTO -> start StartStop.UNDEFINED and wait for a call to StartStoppable.setStartStop(StartStop)

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
AUTO	Wait for runtime START/STOP command via StartStoppable.setStartStop(StartStop).
START	Force START the Component.
STOP	Force STOP the Component.

Method Summary

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

START

public static final StartStopConfig START

Force START the Component.

STOP

public static final StartStopConfig STOP

Force STOP the Component.

AUTO

public static final StartStopConfig AUTO

Wait for runtime START/STOP command via StartStoppable.setStartStop(StartStop).

Method Details

values

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