org.ogema.drivers.modbus.enums

Enum FunctionCode

java.lang.Object

java.lang.Enum<FunctionCode>

org.ogema.drivers.modbus.enums.FunctionCode

All Implemented Interfaces:

Serializable, Comparable<FunctionCode>

public enum FunctionCode
extends Enum<FunctionCode>

Supported modbuss function codes

Enum Constant Summary

Enum Constants

Enum Constant and Description
FC_01_READ_COILS
FC_02_READ_DISCRETE_INPUTS
FC_03_READ_HOLDING_REGISTERS
FC_04_READ_INPUT_REGISTERS
FC_05_WRITE_SINGLE_COIL
FC_06_WRITE_SINGLE_REGISTER
FC_15_WRITE_MULITPLE_COILS
FC_16_WRITE_MULTIPLE_REGISTERS

Method Summary

Modifier and Type	Method and Description
static FunctionCode	fromValue(int value)
static FunctionCode	getFunctionCodeFromRegisterType(boolean read, RegisterType type, DataType dataType)
static FunctionCode	getFunctionCodeFromRegisterType(boolean read, RegisterType type, DataType dataType, int count)
int	getValue()
void	setValue(int value)
static FunctionCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FunctionCode[]	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

FC_01_READ_COILS

public static final FunctionCode FC_01_READ_COILS

FC_02_READ_DISCRETE_INPUTS

public static final FunctionCode FC_02_READ_DISCRETE_INPUTS

FC_03_READ_HOLDING_REGISTERS

public static final FunctionCode FC_03_READ_HOLDING_REGISTERS

FC_04_READ_INPUT_REGISTERS

public static final FunctionCode FC_04_READ_INPUT_REGISTERS

FC_05_WRITE_SINGLE_COIL

public static final FunctionCode FC_05_WRITE_SINGLE_COIL

FC_06_WRITE_SINGLE_REGISTER

public static final FunctionCode FC_06_WRITE_SINGLE_REGISTER

FC_15_WRITE_MULITPLE_COILS

public static final FunctionCode FC_15_WRITE_MULITPLE_COILS

FC_16_WRITE_MULTIPLE_REGISTERS

public static final FunctionCode FC_16_WRITE_MULTIPLE_REGISTERS

Method Detail

values

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

Returns:

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

valueOf

public static FunctionCode 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

fromValue

public static FunctionCode fromValue(int value)
                              throws EnumConstantNotPresentException

Throws:

EnumConstantNotPresentException

getValue

public int getValue()

setValue

public void setValue(int value)

getFunctionCodeFromRegisterType

public static FunctionCode getFunctionCodeFromRegisterType(boolean read,
                                                           RegisterType type,
                                                           DataType dataType)
                                                    throws RuntimeException

Throws:

RuntimeException

getFunctionCodeFromRegisterType

public static FunctionCode getFunctionCodeFromRegisterType(boolean read,
                                                           RegisterType type,
                                                           DataType dataType,
                                                           int count)
                                                    throws RuntimeException

Parameters:

read -

type -

dataType -

count - only evaluated if it is required but cannot be derived from the dataType, i.e. for write actions for String and Bytearray types

Returns:

Throws:

RuntimeException