Package io.openems.edge.bridge.modbus.api

Enum Class BridgeModbus.ChannelId

java.lang.Object

java.lang.Enum<BridgeModbus.ChannelId>

io.openems.edge.bridge.modbus.api.BridgeModbus.ChannelId

All Implemented Interfaces:

ChannelId, Serializable, Comparable<BridgeModbus.ChannelId>, Constable

Enclosing interface:

BridgeModbus

public static enum BridgeModbus.ChannelId
extends Enum<BridgeModbus.ChannelId>
implements ChannelId

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface io.openems.edge.common.channel.ChannelId

ChannelId.ChannelIdImpl

Enum Constant Summary

Enum Constants

Enum Constant	Description
CYCLE_DELAY	Delay per Cycle before starting to execute Modbus Tasks.
CYCLE_TIME_IS_TOO_SHORT

Method Summary

Modifier and Type	Method	Description
Doc	doc()	Gets the Channel Doc for this ChannelId.
static BridgeModbus.ChannelId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BridgeModbus.ChannelId[]	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.edge.common.channel.ChannelId

id, name

Enum Constant Details

CYCLE_TIME_IS_TOO_SHORT

public static final BridgeModbus.ChannelId CYCLE_TIME_IS_TOO_SHORT

CYCLE_DELAY

public static final BridgeModbus.ChannelId CYCLE_DELAY

Delay per Cycle before starting to execute Modbus Tasks. Global Cycle-Time can be reduced by this amount, without causing CYCLE_TIME_IS_TOO_SHORT.

Method Details

values

public static BridgeModbus.ChannelId[] 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 BridgeModbus.ChannelId 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

doc

public Doc doc()

Description copied from interface: ChannelId

Gets the Channel Doc for this ChannelId.

Specified by:

doc in interface ChannelId

Returns:

the Channel-Doc