Package org.openhab.core.io.transport.modbus

Enum Class ModbusWriteFunctionCode

java.lang.Object

java.lang.Enum<ModbusWriteFunctionCode>

org.openhab.core.io.transport.modbus.ModbusWriteFunctionCode

All Implemented Interfaces:

Serializable, Comparable<ModbusWriteFunctionCode>, Constable

@NonNullByDefault
public enum ModbusWriteFunctionCode
extends Enum<ModbusWriteFunctionCode>

Modbus write function codes supported by this transport

Author:

Sami Salonen - Initial contribution

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
WRITE_COIL
WRITE_MULTIPLE_COILS
WRITE_MULTIPLE_REGISTERS
WRITE_SINGLE_REGISTER

Method Summary

Modifier and Type	Method	Description
static ModbusWriteFunctionCode	fromFunctionCode(int functionCode)	Construct ModbusWriteFunctionCode from the numeric function code
int	getFunctionCode()	Get numeric function code represented by this instance
static ModbusWriteFunctionCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModbusWriteFunctionCode[]	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

WRITE_COIL

public static final ModbusWriteFunctionCode WRITE_COIL

WRITE_MULTIPLE_COILS

public static final ModbusWriteFunctionCode WRITE_MULTIPLE_COILS

WRITE_SINGLE_REGISTER

public static final ModbusWriteFunctionCode WRITE_SINGLE_REGISTER

WRITE_MULTIPLE_REGISTERS

public static final ModbusWriteFunctionCode WRITE_MULTIPLE_REGISTERS

Method Details

values

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

getFunctionCode

public int getFunctionCode()

Get numeric function code represented by this instance

Returns:

fromFunctionCode

public static ModbusWriteFunctionCode fromFunctionCode(int functionCode)
                                                throws IllegalArgumentException

Construct ModbusWriteFunctionCode from the numeric function code

Parameters:

functionCode - numeric function code

Returns:

ModbusWriteFunctionCode matching the numeric function code

Throws:

IllegalArgumentException - with unsupported functions