Package io.openems.edge.controller.api.modbus

Enum ModbusTcpApi.ChannelId

java.lang.Object

java.lang.Enum<ModbusTcpApi.ChannelId>

io.openems.edge.controller.api.modbus.ModbusTcpApi.ChannelId

All Implemented Interfaces:

ChannelId, java.io.Serializable, java.lang.Comparable<ModbusTcpApi.ChannelId>

Enclosing interface:

ModbusTcpApi

public static enum ModbusTcpApi.ChannelId
extends java.lang.Enum<ModbusTcpApi.ChannelId>
implements ChannelId

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPONENT_MISSING_FAULT
COMPONENT_NO_MODBUS_API_FAULT
PROCESS_IMAGE_FAULT
UNABLE_TO_START

Method Summary

Modifier and Type	Method	Description
Doc	doc()	Gets the Channel Doc for this ChannelId.
static ModbusTcpApi.ChannelId	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ModbusTcpApi.ChannelId[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, 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 Detail

UNABLE_TO_START

public static final ModbusTcpApi.ChannelId UNABLE_TO_START

COMPONENT_NO_MODBUS_API_FAULT

public static final ModbusTcpApi.ChannelId COMPONENT_NO_MODBUS_API_FAULT

COMPONENT_MISSING_FAULT

public static final ModbusTcpApi.ChannelId COMPONENT_MISSING_FAULT

PROCESS_IMAGE_FAULT

public static final ModbusTcpApi.ChannelId PROCESS_IMAGE_FAULT

Method Detail

values

public static ModbusTcpApi.ChannelId[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModbusTcpApi.ChannelId c : ModbusTcpApi.ChannelId.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModbusTcpApi.ChannelId valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.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