net.wimpi.modbus.msg
Class ReadMultipleRegistersResponse

java.lang.Object
  net.wimpi.modbus.msg.ModbusMessageImpl
      net.wimpi.modbus.msg.ModbusResponse
          net.wimpi.modbus.msg.ReadMultipleRegistersResponse

All Implemented Interfaces:

Transportable, ModbusMessage

public final class ReadMultipleRegistersResponse
extends ModbusResponse

Class implementing a ReadMultipleRegistersResponse. The implementation directly correlates with the class 0 function read multiple registers (FC 3). It encapsulates the corresponding response message.

Version:

@version@ (@date@)

Author:

Dieter Wimberger

Constructor Summary

ReadMultipleRegistersResponse()
Constructs a new ReadMultipleRegistersResponse instance.

ReadMultipleRegistersResponse(Register[] registers)
Constructs a new ReadInputRegistersResponse instance.

Method Summary

int	getByteCount() Returns the number of bytes that have been read.
Register	getRegister(int index) Returns the Register at the given position (relative to the reference used in the request).
Register[]	getRegisters() Returns a reference to the array of registers read.
int	getRegisterValue(int index) Returns the value of the register at the given position (relative to the reference used in the request) interpreted as unsigned short.
int	getWordCount() Returns the number of words that have been read.
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 net.wimpi.modbus.msg.ModbusResponse

createModbusResponse

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

ReadMultipleRegistersResponse

public ReadMultipleRegistersResponse()

Constructs a new ReadMultipleRegistersResponse instance.

ReadMultipleRegistersResponse

public ReadMultipleRegistersResponse(Register[] registers)

Constructs a new ReadInputRegistersResponse instance.

Parameters:

registers - the Register[] holding response registers.

Method Detail

getByteCount

public int getByteCount()

Returns the number of bytes that have been read.

Returns:

the number of bytes that have been read as int.

getWordCount

public int getWordCount()

Returns the number of words that have been read. The returned value should be half of the the byte count of this ReadMultipleRegistersResponse.

Returns:

the number of words that have been read as int.

getRegisterValue

public int getRegisterValue(int index)
                     throws IndexOutOfBoundsException

Returns the value of the register at the given position (relative to the reference used in the request) interpreted as unsigned short.

Parameters:

index - the relative index of the register for which the value should be retrieved.

Returns:

the value as int.

Throws:

IndexOutOfBoundsException - if the index is out of bounds.

getRegister

public Register getRegister(int index)
                     throws IndexOutOfBoundsException

Returns the Register at the given position (relative to the reference used in the request).

Parameters:

index - the relative index of the Register.

Returns:

the register as Register.

Throws:

IndexOutOfBoundsException - if the index is out of bounds.

getRegisters

public Register[] getRegisters()

Returns a reference to the array of registers read.

Returns:

a Register[] instance.

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.