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

Enum Class ModbusConstants.ValueType

java.lang.Object

java.lang.Enum<ModbusConstants.ValueType>

org.openhab.core.io.transport.modbus.ModbusConstants.ValueType

All Implemented Interfaces:

Serializable, Comparable<ModbusConstants.ValueType>, Constable

Enclosing class:

ModbusConstants

public static enum ModbusConstants.ValueType
extends Enum<ModbusConstants.ValueType>

Value types for different number types.

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
BIT
FLOAT32
FLOAT32_SWAP
INT16
INT32
INT32_SWAP
INT64
INT64_SWAP
INT8
UINT16
UINT32
UINT32_SWAP
UINT64
UINT64_SWAP
UINT8

Method Summary

Modifier and Type	Method	Description
static ModbusConstants.ValueType	fromConfigValue(@Nullable String configValueType)	Constructs ValueType given the config value string.
int	getBits()	Returns number of bits represented by this ValueType
String	getConfigValue()	Returns config value to refer to this value type
String	toString()	Returns config value
static ModbusConstants.ValueType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModbusConstants.ValueType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BIT

public static final ModbusConstants.ValueType BIT

INT8

public static final ModbusConstants.ValueType INT8

UINT8

public static final ModbusConstants.ValueType UINT8

INT16

public static final ModbusConstants.ValueType INT16

UINT16

public static final ModbusConstants.ValueType UINT16

INT32

public static final ModbusConstants.ValueType INT32

UINT32

public static final ModbusConstants.ValueType UINT32

FLOAT32

public static final ModbusConstants.ValueType FLOAT32

INT64

public static final ModbusConstants.ValueType INT64

UINT64

public static final ModbusConstants.ValueType UINT64

INT32_SWAP

public static final ModbusConstants.ValueType INT32_SWAP

UINT32_SWAP

public static final ModbusConstants.ValueType UINT32_SWAP

FLOAT32_SWAP

public static final ModbusConstants.ValueType FLOAT32_SWAP

INT64_SWAP

public static final ModbusConstants.ValueType INT64_SWAP

UINT64_SWAP

public static final ModbusConstants.ValueType UINT64_SWAP

Method Details

values

public static ModbusConstants.ValueType[] 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 ModbusConstants.ValueType 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

getBits

public int getBits()

Returns number of bits represented by this ValueType

Returns:

number of bits

getConfigValue

public String getConfigValue()

Returns config value to refer to this value type

Returns:

config value as string

toString

public String toString()

Returns config value

Overrides:

toString in class Enum<ModbusConstants.ValueType>

fromConfigValue

public static ModbusConstants.ValueType fromConfigValue(@Nullable String configValueType)
                                                 throws IllegalArgumentException

Constructs ValueType given the config value string.

Parameters:

configValueType - config value that will be parsed to ValueType

Returns:

ValueType matching the config value

Throws:

IllegalArgumentException - with unknown value types