net.wimpi.modbus.msg
Class WriteSingleRegisterRequest

java.lang.Object
  net.wimpi.modbus.msg.ModbusMessageImpl
      net.wimpi.modbus.msg.ModbusRequest
          net.wimpi.modbus.msg.WriteSingleRegisterRequest

All Implemented Interfaces:

Transportable, ModbusMessage

public final 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:

@version@ (@date@)

Author:

Dieter Wimberger

Constructor Summary

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

ModbusResponse	createResponse() Returns the ModbusResponse that represents the answer to this ModbusRequest.
int	getReference() Returns the reference of the register to be written to with this WriteSingleRegisterRequest.
Register	getRegister() Returns the value that should be written to the register with this WriteSingleRegisterRequest.
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 net.wimpi.modbus.msg.ModbusRequest

createExceptionResponse, createModbusRequest

Methods inherited from class net.wimpi.modbus.msg.ModbusMessageImpl

getDataLength, getFunctionCode, getHexMessage, getOutputLength, getProtocolID, getTransactionID, getUnitID, isHeadless, readFrom, setDataLength, 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

createResponse

public ModbusResponse createResponse()

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.

Specified by:

createResponse in class ModbusRequest

Returns:

the corresponding ModbusResponse.

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.

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.

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.

getRegister

public Register getRegister()

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

Returns:

the value to be written to the 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.