Package net.solarnetwork.node.control.modbus

Enum Class ModbusControlCsvColumn

java.lang.Object

java.lang.Enum<ModbusControlCsvColumn>

net.solarnetwork.node.control.modbus.ModbusControlCsvColumn

All Implemented Interfaces:

Serializable, Comparable<ModbusControlCsvColumn>, Constable, net.solarnetwork.domain.CodedValue

public enum ModbusControlCsvColumn
extends Enum<ModbusControlCsvColumn>
implements net.solarnetwork.domain.CodedValue

The defined column order for Modbus Control CSV.

Version:

1.0

Author:

matt

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
CONTROL_ID	The control ID.
DATA_LENGTH	The data length.
DATA_TYPE	The data type.
DECIMAL_SCALE	The decimal scale.
INSTANCE_ID	The instance ID.
MULTIPLIER	The unit multiplier.
NETWORK_NAME	The connection name.
PROP_TYPE	The property type.
REG_ADDR	The register address.
REG_TYPE	The register type.
SAMPLE_CACHE	The sample cache milliseconds.
UNIT_ID	The unit ID.
WORD_ORDER	The word order.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<ModbusControlCsvColumn>	DEVICE_WIDE_COLUMNS	The set of columns are specify device-wide settings.

Method Summary

Modifier and Type	Method	Description
int	getCode()
String	getName()	Get a friendly name for the column.
static ModbusControlCsvColumn	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModbusControlCsvColumn[]	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

INSTANCE_ID

public static final ModbusControlCsvColumn INSTANCE_ID

The instance ID.

NETWORK_NAME

public static final ModbusControlCsvColumn NETWORK_NAME

The connection name.

UNIT_ID

public static final ModbusControlCsvColumn UNIT_ID

The unit ID.

SAMPLE_CACHE

public static final ModbusControlCsvColumn SAMPLE_CACHE

The sample cache milliseconds.

WORD_ORDER

public static final ModbusControlCsvColumn WORD_ORDER

The word order.

CONTROL_ID

public static final ModbusControlCsvColumn CONTROL_ID

The control ID.

PROP_TYPE

public static final ModbusControlCsvColumn PROP_TYPE

The property type.

REG_ADDR

public static final ModbusControlCsvColumn REG_ADDR

The register address.

REG_TYPE

public static final ModbusControlCsvColumn REG_TYPE

The register type.

DATA_TYPE

public static final ModbusControlCsvColumn DATA_TYPE

The data type.

DATA_LENGTH

public static final ModbusControlCsvColumn DATA_LENGTH

The data length.

MULTIPLIER

public static final ModbusControlCsvColumn MULTIPLIER

The unit multiplier.

DECIMAL_SCALE

public static final ModbusControlCsvColumn DECIMAL_SCALE

The decimal scale.

Field Details

DEVICE_WIDE_COLUMNS

public static final Set<ModbusControlCsvColumn> DEVICE_WIDE_COLUMNS

The set of columns are specify device-wide settings.

Method Details

values

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

getCode

public int getCode()

Specified by:

getCode in interface net.solarnetwork.domain.CodedValue

getName

public String getName()

Get a friendly name for the column.

Returns:

the name