com.ghgande.j2mod.modbus.msg

Class WriteMultipleRegistersResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.WriteMultipleRegistersResponse

All Implemented Interfaces:

ModbusMessage

public class WriteMultipleRegistersResponse
extends ModbusResponse

Class implementing a WriteMultipleRegistersResponse. The implementation directly correlates with the class 0 function preset multiple registers (FC 16). It encapsulates the corresponding response message.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Nested Class Summary

Nested classes/interfaces inherited from class com.ghgande.j2mod.modbus.msg.ModbusResponse

ModbusResponse.AuxiliaryMessageTypes

Constructor Summary

Constructors

Constructor and Description
WriteMultipleRegistersResponse() Constructs a new WriteMultipleRegistersResponse instance.
WriteMultipleRegistersResponse(int reference, int wordCount) Constructs a new WriteMultipleRegistersResponse instance.

Method Summary

Modifier and Type	Method and Description
int	getByteCount() Returns the number of bytes that have been written.
byte[]	getMessage() Returns the raw message as an array of bytes.
int	getReference() Returns the reference of the register to start writing to with this WriteMultipleRegistersResponse.
int	getWordCount() Returns the number of words that have been written.
void	readData(DataInput din) Reads the subclass specific data from the given DataInput instance.
void	setReference(int ref) Sets the reference of the register to start writing to with this WriteMultipleRegistersResponse.
void	setWordCount(int count) Sets the number of words that have been returned.
void	writeData(DataOutput dout) Writes the subclass specific data to the given DataOutput.

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

createModbusResponse, getAuxiliaryType, setAuxiliaryType

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

WriteMultipleRegistersResponse

public WriteMultipleRegistersResponse()

Constructs a new WriteMultipleRegistersResponse instance.

WriteMultipleRegistersResponse

public WriteMultipleRegistersResponse(int reference,
                                      int wordCount)

Constructs a new WriteMultipleRegistersResponse instance.

Parameters:

reference - the offset to start writing from.

wordCount - the number of words (registers) to be written.

Method Detail

getReference

public int getReference()

Returns the reference of the register to start writing to with this WriteMultipleRegistersResponse.

Returns:

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

setReference

public void setReference(int ref)

Sets the reference of the register to start writing to with this WriteMultipleRegistersResponse.

Parameters:

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

getByteCount

public int getByteCount()

Returns the number of bytes that have been written.

Returns:

the number of bytes that have been written as int.

getWordCount

public int getWordCount()

Returns the number of words that have been written. The returned value should be half of the byte count of the response.

Returns:

the number of words that have been written as int.

setWordCount

public void setWordCount(int count)

Sets the number of words that have been returned.

Parameters:

count - the number of words as int.

writeData

public void writeData(DataOutput dout)
               throws IOException

Description copied from class: ModbusMessageImpl

Writes the subclass specific data to the given DataOutput.

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 din)
              throws IOException

Description copied from class: ModbusMessageImpl

Reads the subclass specific data from the given DataInput instance.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - 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[].