Package org.apache.plc4x.java.modbus.base.tag

Class ModbusTag

java.lang.Object

org.apache.plc4x.java.modbus.base.tag.ModbusTag

All Implemented Interfaces:

PlcTag, Serializable

Direct Known Subclasses:

ModbusTagCoil, ModbusTagDiscreteInput, ModbusTagExtendedRegister, ModbusTagHoldingRegister, ModbusTagInputRegister

public abstract class ModbusTag
extends Object
implements PlcTag, Serializable

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	ADDRESS_PATTERN
static Pattern	FIXED_DIGIT_MODBUS_PATTERN
static int	PROTOCOL_ADDRESS_OFFSET

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModbusTag(int address, Integer quantity, ModbusDataType dataType)	Instantiate a new ModbusTag

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getAddress()	Get the technical address that must be used 'on the wire'
String	getAddressString()
protected abstract String	getAddressStringPrefix()
List<ArrayInfo>	getArrayInfo()
ModbusDataType	getDataType()
int	getLengthBytes()
int	getLengthWords()
abstract int	getLogicalAddress()	Get the logical (configured) address
int	getNumberOfElements()
PlcValueType	getPlcValueType()
int	hashCode()
static ModbusTag	of(String addressString)
void	serialize(WriteBuffer writeBuffer)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADDRESS_PATTERN

public static final Pattern ADDRESS_PATTERN

FIXED_DIGIT_MODBUS_PATTERN

public static final Pattern FIXED_DIGIT_MODBUS_PATTERN

PROTOCOL_ADDRESS_OFFSET

public static final int PROTOCOL_ADDRESS_OFFSET

See Also:

Constant Field Values

Constructor Detail

ModbusTag

protected ModbusTag(int address,
                    Integer quantity,
                    ModbusDataType dataType)

Instantiate a new ModbusTag

Parameters:

address - The WIRE address that is to be used.

quantity - The number of registers

dataType - The type for the interpretation of the registers.

Method Detail

of

public static ModbusTag of(String addressString)

getAddressString

public String getAddressString()

Specified by:

getAddressString in interface PlcTag

getAddressStringPrefix

protected abstract String getAddressStringPrefix()

getAddress

public int getAddress()

Get the technical address that must be used 'on the wire'

Returns:

The address that is to be used on the wire (shifted by 1 because of the modbus spec).

getLogicalAddress

public abstract int getLogicalAddress()

Get the logical (configured) address

Returns:

The address which was configured and is different from what is used on the wire.

getNumberOfElements

public int getNumberOfElements()

getLengthBytes

public int getLengthBytes()

getLengthWords

public int getLengthWords()

getDataType

public ModbusDataType getDataType()

getPlcValueType

public PlcValueType getPlcValueType()

Specified by:

getPlcValueType in interface PlcTag

getArrayInfo

public List<ArrayInfo> getArrayInfo()

Specified by:

getArrayInfo in interface PlcTag

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

serialize

public void serialize(WriteBuffer writeBuffer)
               throws SerializationException

Specified by:

serialize in interface Serializable

Throws:

SerializationException