com.ghgande.j2mod.modbus.msg

Class WriteMultipleRegistersRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersRequest

All Implemented Interfaces:

ModbusMessage

public class WriteMultipleRegistersRequest
extends ModbusRequest

Class implementing a WriteMultipleRegistersRequest. The implementation directly correlates with the class 0 function write multiple registers (FC 16). It encapsulates the corresponding request message.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, jfhaugh, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
WriteMultipleRegistersRequest() Constructs a new WriteMultipleRegistersRequest instance.
WriteMultipleRegistersRequest(int first, Register[] registers) Constructs a new WriteMultipleRegistersRequest instance with a given starting reference and values to be written.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) createResponse - Returns the WriteMultipleRegistersResponse that represents the answer to this WriteMultipleRegistersRequest.
int	getByteCount() getByteCount - Returns the number of bytes representing the values to be written.
byte[]	getMessage() Returns the raw message as an array of bytes.
NonWordDataHandler	getNonWordDataHandler() getNonWordDataHandler - Returns the actual non word data handler.
int	getReference() setReference - Returns the reference of the register to start writing to with this WriteMultipleRegistersRequest.
Register	getRegister(int index) getRegister - Returns the Register at the given position.
Register[]	getRegisters() getRegisters - Returns the registers to be written with this WriteMultipleRegistersRequest.
int	getRegisterValue(int index) getRegisterValue - Returns the value of the specified register.
ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.
int	getWordCount() getWordCount - Returns the number of words to be written.
void	readData(DataInput input) Reads the subclass specific data from the given DataInput instance.
void	setNonWordDataHandler(NonWordDataHandler dhandler) setNonWordHandler - Sets a non word data handler.
void	setReference(int ref) setReference - Sets the reference of the register to write to with this WriteMultipleRegistersRequest.
void	setRegisters(Register[] registers) setRegisters - Sets the registers to be written with this WriteMultipleRegistersRequest.
void	writeData(DataOutput output) Writes the subclass specific data to the given DataOutput.

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

WriteMultipleRegistersRequest

public WriteMultipleRegistersRequest(int first,
                                     Register[] registers)

Constructs a new WriteMultipleRegistersRequest instance with a given starting reference and values to be written.

Parameters:

first - -- the address of the first register to write to.

registers - -- the registers to be written.

WriteMultipleRegistersRequest

public WriteMultipleRegistersRequest()

Constructs a new WriteMultipleRegistersRequest 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)

createResponse - Returns the WriteMultipleRegistersResponse that represents the answer to this WriteMultipleRegistersRequest. The implementation should take care about assembling the reply to this WriteMultipleRegistersRequest. 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.

createResponse() must be able to handle the case where the word data that is in the response is actually non-word data. That is, where the slave device has data which are not actually short values in the range of registers being processed.

getReference

public int getReference()

setReference - Returns the reference of the register to start writing to with this WriteMultipleRegistersRequest.

Returns:

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

setReference

public void setReference(int ref)

setReference - Sets the reference of the register to write to with this WriteMultipleRegistersRequest.

Parameters:

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

getRegisters

public Register[] getRegisters()

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

Returns:

the registers to be written as Register[].

setRegisters

public void setRegisters(Register[] registers)

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

Parameters:

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

getRegister

public Register getRegister(int index)
                     throws IndexOutOfBoundsException

getRegister - Returns the Register at the given position.

Parameters:

index - the relative index of the Register.

Returns:

the register as Register.

Throws:

IndexOutOfBoundsException - if the index is out of bounds.

getRegisterValue

public int getRegisterValue(int index)
                     throws IndexOutOfBoundsException

getRegisterValue - Returns the value of the specified register.

Parameters:

index - the index of the desired register.

Returns:

the value as an 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.

getWordCount

public int getWordCount()

getWordCount - Returns the number of words to be written.

Returns:

the number of words to be written as int.

getNonWordDataHandler

public NonWordDataHandler getNonWordDataHandler()

getNonWordDataHandler - Returns the actual non word data handler.

Returns:

the actual NonWordDataHandler.

setNonWordDataHandler

public void setNonWordDataHandler(NonWordDataHandler dhandler)

setNonWordHandler - 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 output)
               throws IOException

Description copied from class: ModbusMessageImpl

Writes the subclass specific data to the given DataOutput.

Specified by:

writeData in class ModbusMessageImpl

Parameters:

output - the DataOutput to be written to.

Throws:

IOException - if an I/O related error occurs.

readData

public void readData(DataInput input)
              throws IOException

Description copied from class: ModbusMessageImpl

Reads the subclass specific data from the given DataInput instance.

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()

Description copied from interface: ModbusMessage

Returns the raw message as an array of bytes.

Returns:

the raw message as byte[].