com.ghgande.j2mod.modbus.msg

Class ReadFileRecordResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.ReadFileRecordResponse

All Implemented Interfaces:

ModbusMessage

public class ReadFileRecordResponse
extends ModbusResponse

Class implementing a ReadFileRecordResponse.

Version:

2.0 (March 2016)

Author:

Julie (jfh@ghgande.com), Steve O'Hara (4NG)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadFileRecordResponse.RecordResponse

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

ModbusResponse.AuxiliaryMessageTypes

Constructor Summary

Constructors

Constructor and Description
ReadFileRecordResponse() Constructs a new ReadFileRecordResponse instance.

Method Summary

Modifier and Type	Method and Description
void	addResponse(ReadFileRecordResponse.RecordResponse response) addResponse -- add a new record response.
int	getByteCount() Returns the number of bytes needed for the response.
byte[]	getMessage() Returns the raw message as an array of bytes.
ReadFileRecordResponse.RecordResponse	getRecord(int index) getRecord
int	getRecordCount() getRecordCount -- return the number of records in the response.
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

ReadFileRecordResponse

public ReadFileRecordResponse()

Constructs a new ReadFileRecordResponse instance.

Method Detail

getByteCount

public int getByteCount()

Returns the number of bytes needed for the response. The response is 1 byte for the total response size, plus the sum of the sizes of all the records in the response.

Returns:

the number of bytes in the response.

getRecordCount

public int getRecordCount()

getRecordCount -- return the number of records in the response.

Returns:

count of records in response.

getRecord

public ReadFileRecordResponse.RecordResponse getRecord(int index)

getRecord

Parameters:

index - Record to get

Returns:

the record response indicated by the reference

addResponse

public void addResponse(ReadFileRecordResponse.RecordResponse response)

addResponse -- add a new record response.

Parameters:

response - Record response to add

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