com.ghgande.j2mod.modbus.msg

Class ReadWriteMultipleRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.ReadWriteMultipleRequest

All Implemented Interfaces:

ModbusMessage

public class ReadWriteMultipleRequest
extends ModbusRequest

Class implementing a Read / Write Multiple Registers request.

Version:

2.0 (March 2016)

Author:

Julie Haugh, Julie Haugh, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
ReadWriteMultipleRequest() Constructs a new Read/Write Multiple Registers Request instance.
ReadWriteMultipleRequest(int unit) Constructs a new Read/Write Multiple Registers Request instance.
ReadWriteMultipleRequest(int unit, int readRef, int readCount, int writeRef, int writeCount) Constructs a new Read/Write Multiple Registers Request instance.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
int	getByteCount() getByteCount - Returns the number of bytes representing the values to be written.
byte[]	getMessage() getMessage -- return a prepared message.
NonWordDataHandler	getNonWordDataHandler() getNonWordDataHandler - Returns the actual non word data handler.
int	getReadReference() getReadReference - Returns the reference of the register to start writing to with this ReadWriteMultipleRequest.
int	getReadRegisterValue(int index) getReadRegisterValue - Returns the value of the specified register interpreted as unsigned short.
int	getReadWordCount() getReadWordCount - Returns the number of words to be read.
Register	getRegister(int index) getRegister - Returns the specified Register.
Register[]	getRegisters() getRegisters - Returns the registers to be written with this ReadWriteMultipleRequest.
ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.
int	getWriteReference() getWriteReference - Returns the reference of the register to start writing to with this ReadWriteMultipleRequest.
int	getWriteWordCount() getWriteWordCount - Returns the number of words to be written.
void	readData(DataInput input) readData -- read the values of the registers to be written, along with the reference and count for the registers to be read.
void	setNonWordDataHandler(NonWordDataHandler dhandler) setNonWordDataHandler - Sets a non word data handler.
void	setReadReference(int ref) setReadReference - Sets the reference of the register to writing to with this ReadWriteMultipleRequest.
void	setReadWordCount(int count) setReadWordCount - Sets the number of words to be read.
void	setRegisters(Register[] registers) setRegisters - Sets the registers to be written with this ReadWriteMultipleRequest.
void	setWriteReference(int ref) setWriteReference - Sets the reference of the register to write to with this ReadWriteMultipleRequest.
void	setWriteWordCount(int count) setWriteWordCount - Sets the number of words to be written.
void	writeData(DataOutput dout) writeData -- output this Modbus message to dout.

Methods inherited from class com.ghgande.j2mod.modbus.msg.ModbusRequest

createExceptionResponse, createModbusRequest

Methods inherited from class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

getDataLength, getFunctionCode, getHexMessage, getOutputLength, getProtocolID, getTransactionID, getUnitID, isHeadless, readFrom, setDataLength, setHeadless, setHeadless, setProtocolID, setTransactionID, setUnitID, writeTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadWriteMultipleRequest

public ReadWriteMultipleRequest(int unit,
                                int readRef,
                                int readCount,
                                int writeRef,
                                int writeCount)

Constructs a new Read/Write Multiple Registers Request instance.

Parameters:

unit - Unit ID

readRef - Register to read

writeCount - Number of registers to write

writeRef - Starting register to write

readCount - Number of registers to read

ReadWriteMultipleRequest

public ReadWriteMultipleRequest(int unit)

Constructs a new Read/Write Multiple Registers Request instance.

Parameters:

unit - Unit ID

ReadWriteMultipleRequest

public ReadWriteMultipleRequest()

Constructs a new Read/Write Multiple Registers Request instance.

Method Detail

getResponse

public ModbusResponse getResponse()

Description copied from class: ModbusRequest

Returns the ModbusResponse that correlates with this ModbusRequest.

The response must include the unit number, function code, as well as any transport-specific header information.

This method is used to create an empty response which must be populated by the caller. It is commonly used to un-marshal responses from Modbus slaves.

Specified by:

getResponse in class ModbusRequest

Returns:

the corresponding ModbusResponse.

createResponse

public ModbusResponse createResponse(AbstractModbusListener listener)

Description copied from class: ModbusRequest

Returns the ModbusResponse that represents the answer to this ModbusRequest.

The implementation should take care about assembling the reply to this ModbusRequest.

This method is used to create responses from the process image associated with the listener. It is commonly used to implement Modbus slave instances.

Specified by:

createResponse in class ModbusRequest

Parameters:

listener - Listener that received the request

Returns:

the corresponding ModbusResponse.

getReadReference

public int getReadReference()

getReadReference - Returns the reference of the register to start writing to with this ReadWriteMultipleRequest.

Returns:

the reference of the register to start writing to as int .

setReadReference

public void setReadReference(int ref)

setReadReference - Sets the reference of the register to writing to with this ReadWriteMultipleRequest.

Parameters:

ref - the reference of the register to start writing to as int.

getWriteReference

public int getWriteReference()

getWriteReference - Returns the reference of the register to start writing to with this ReadWriteMultipleRequest.

Returns:

the reference of the register to start writing to as int .

setWriteReference

public void setWriteReference(int ref)

setWriteReference - Sets the reference of the register to write to with this ReadWriteMultipleRequest.

Parameters:

ref - the reference of the register to start writing to as int.

getRegisters

public Register[] getRegisters()

getRegisters - Returns the registers to be written with this ReadWriteMultipleRequest.

Returns:

the registers to be read as Register[].

setRegisters

public void setRegisters(Register[] registers)

setRegisters - Sets the registers to be written with this ReadWriteMultipleRequest.

Parameters:

registers - the registers to be written as Register[].

getRegister

public Register getRegister(int index)
                     throws IndexOutOfBoundsException

getRegister - Returns the specified Register.

Parameters:

index - the index of the Register.

Returns:

the register as Register.

Throws:

IndexOutOfBoundsException - if the index is out of bounds.

getReadRegisterValue

public int getReadRegisterValue(int index)
                         throws IndexOutOfBoundsException

getReadRegisterValue - Returns the value of the specified register interpreted as unsigned short.

Parameters:

index - the relative index of the register for which the value should be retrieved.

Returns:

the value as int.

Throws:

IndexOutOfBoundsException - if the index is out of bounds.

getByteCount

public int getByteCount()

getByteCount - Returns the number of bytes representing the values to be written.

Returns:

the number of bytes to be written as int.

getWriteWordCount

public int getWriteWordCount()

getWriteWordCount - Returns the number of words to be written.

Returns:

the number of words to be written as int.

setWriteWordCount

public void setWriteWordCount(int count)

setWriteWordCount - Sets the number of words to be written.

Parameters:

count - the number of words to be written as int.

getReadWordCount

public int getReadWordCount()

getReadWordCount - Returns the number of words to be read.

Returns:

the number of words to be read as int.

setReadWordCount

public void setReadWordCount(int count)

setReadWordCount - Sets the number of words to be read.

Parameters:

count - the number of words to be read as int.

getNonWordDataHandler

public NonWordDataHandler getNonWordDataHandler()

getNonWordDataHandler - Returns the actual non word data handler.

Returns:

the actual NonWordDataHandler.

setNonWordDataHandler

public void setNonWordDataHandler(NonWordDataHandler dhandler)

setNonWordDataHandler - Sets a non word data handler. A non-word data handler is responsible for converting words from a Modbus packet into the non-word values associated with the actual device's registers.

Parameters:

dhandler - a NonWordDataHandler instance.

writeData

public void writeData(DataOutput dout)
               throws IOException

writeData -- output this Modbus message to dout.

Specified by:

writeData in class ModbusMessageImpl

Parameters:

dout - the DataOutput to be written to.

Throws:

IOException - if an I/O related error occurs.

readData

public void readData(DataInput input)
              throws IOException

readData -- read the values of the registers to be written, along with the reference and count for the registers to be read.

Specified by:

readData in class ModbusMessageImpl

Parameters:

input - the DataInput to read from.

Throws:

IOException - if an I/O related error occurs.

getMessage

public byte[] getMessage()

getMessage -- return a prepared message.

Returns:

prepared message