com.ghgande.j2mod.modbus.msg

Class WriteSingleRegisterRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.WriteSingleRegisterRequest

All Implemented Interfaces:

ModbusMessage

public class WriteSingleRegisterRequest
extends ModbusRequest

Class implementing a WriteSingleRegisterRequest. The implementation directly correlates with the class 0 function write single register (FC 6). It encapsulates the corresponding request message.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
WriteSingleRegisterRequest() Constructs a new WriteSingleRegisterRequest instance.
WriteSingleRegisterRequest(int ref, Register reg) Constructs a new WriteSingleRegisterRequest instance with a given reference and value to be written.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
byte[]	getMessage() Returns the raw message as an array of bytes.
int	getReference() Returns the reference of the register to be written to with this WriteSingleRegisterRequest.
Register	getRegister() Returns the register to be written with this WriteSingleRegisterRequest.
ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.
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 be written to with this WriteSingleRegisterRequest.
void	setRegister(Register reg) Sets the value that should be written to the register with this WriteSingleRegisterRequest.
void	writeData(DataOutput dout) 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

WriteSingleRegisterRequest

public WriteSingleRegisterRequest()

Constructs a new WriteSingleRegisterRequest instance.

WriteSingleRegisterRequest

public WriteSingleRegisterRequest(int ref,
                                  Register reg)

Constructs a new WriteSingleRegisterRequest instance with a given reference and value to be written.

Parameters:

ref - the reference number of the register to read from.

reg - the register containing the data to be written.

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.

getReference

public int getReference()

Returns the reference of the register to be written to with this WriteSingleRegisterRequest.

Returns:

the reference of the register to be written to.

setReference

public void setReference(int ref)

Sets the reference of the register to be written to with this WriteSingleRegisterRequest.

Parameters:

ref - the reference of the register to be written to.

getRegister

public Register getRegister()

Returns the register to be written with this WriteSingleRegisterRequest.

Returns:

the value to be written to the register.

setRegister

public void setRegister(Register reg)

Sets the value that should be written to the register with this WriteSingleRegisterRequest.

Parameters:

reg - the register to be written.

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