com.ghgande.j2mod.modbus.msg

Class WriteSingleRegisterResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.WriteSingleRegisterResponse

All Implemented Interfaces:

ModbusMessage

public class WriteSingleRegisterResponse
extends ModbusResponse

Class implementing a WriteSingleRegisterResponse. The implementation directly correlates with the class 0 function write single register (FC 6). 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
WriteSingleRegisterResponse() Constructs a new WriteSingleRegisterResponse instance.
WriteSingleRegisterResponse(int reference, int value) Constructs a new WriteSingleRegisterResponse instance.

Method Summary

Modifier and Type	Method and Description
byte[]	getMessage() Returns the raw message as an array of bytes.
int	getReference() Returns the reference of the register that has been written to.
int	getRegisterValue() Returns the value that has been returned in this WriteSingleRegisterResponse.
void	readData(DataInput din) Reads the subclass specific data from the given DataInput instance.
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

WriteSingleRegisterResponse

public WriteSingleRegisterResponse()

Constructs a new WriteSingleRegisterResponse instance.

WriteSingleRegisterResponse

public WriteSingleRegisterResponse(int reference,
                                   int value)

Constructs a new WriteSingleRegisterResponse instance.

Parameters:

reference - the offset of the register written.

value - the value of the register.

Method Detail

getRegisterValue

public int getRegisterValue()

Returns the value that has been returned in this WriteSingleRegisterResponse.

Returns:

the value of the register.

getReference

public int getReference()

Returns the reference of the register that has been written to.

Returns:

the reference of the written register.

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