net.solarnetwork.io.modbus

Enum ModbusBlockType

java.lang.Object

java.lang.Enum<ModbusBlockType>

net.solarnetwork.io.modbus.ModbusBlockType

All Implemented Interfaces:

Serializable, Comparable<ModbusBlockType>

public enum ModbusBlockType
extends Enum<ModbusBlockType>

Modbus register block types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Coil	Coil (toggle) type.
Diagnostic	Diagnostic information.
Discrete	Discrete (input) type.
Holding	Holding (output) type.
Input	Input type.

Method Summary

Modifier and Type	Method	Description
static ModbusBlockType	forCode(int code)	Get an enumeration instance for a code value.
int	getBitCount()	Get the number of bits registers of this type use.
int	getCode()	Get the function code.
boolean	isBitType()	Get the "bit type-ness" of this register block type.
boolean	isReadOnly()	Get the read-only flag.
static ModbusBlockType	valueOf(int code)	Get an enumeration instance for a code value.
static ModbusBlockType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ModbusBlockType[]	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

Enum Constant Detail

Coil

public static final ModbusBlockType Coil

Coil (toggle) type.

Discrete

public static final ModbusBlockType Discrete

Discrete (input) type.

Holding

public static final ModbusBlockType Holding

Holding (output) type.

Input

public static final ModbusBlockType Input

Input type.

Diagnostic

public static final ModbusBlockType Diagnostic

Diagnostic information.

Method Detail

values

public static ModbusBlockType[] 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 (ModbusBlockType c : ModbusBlockType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ModbusBlockType valueOf(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:

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

NullPointerException - if the argument is null

getCode

public int getCode()

Get the function code.

Returns:

the code

getBitCount

public int getBitCount()

Get the number of bits registers of this type use.

Returns:

the bit count

isReadOnly

public boolean isReadOnly()

Get the read-only flag.

Returns:

true if registers of this type are read-only

isBitType

public boolean isBitType()

Get the "bit type-ness" of this register block type.

Returns:

true if this is a coil or discrete register block

valueOf

public static ModbusBlockType valueOf(int code)

Get an enumeration instance for a code value.

Parameters:

code - the code value to get the enumeration for

Returns:

the enumeration, or null if not supported

forCode

public static ModbusBlockType forCode(int code)

Get an enumeration instance for a code value.

Parameters:

code - the code value to get the enumeration for

Returns:

the enumeration

Throws:

IllegalArgumentException - if code is not a valid value