com.ghgande.j2mod.modbus.msg

Class WriteFileRecordResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.WriteFileRecordResponse

All Implemented Interfaces:

ModbusMessage

public class WriteFileRecordResponse
extends ModbusResponse

Class implementing a WriteFileRecordResponse.

Version:

2.0 (March 2016)

Author:

Julie, Steve O'Hara (4NG)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteFileRecordResponse.RecordResponse

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

ModbusResponse.AuxiliaryMessageTypes

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addResponse(WriteFileRecordResponse.RecordResponse response) addResponse -- add a new record response.
byte[]	getMessage() Returns the raw message as an array of bytes.
WriteFileRecordResponse.RecordResponse	getRecord(int index) getRecord -- return the record request indicated by the reference
int	getRequestCount() getRequestCount -- return the number of record requests in this message.
int	getResponseSize() getRequestSize -- return the total request size.
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

WriteFileRecordResponse

public WriteFileRecordResponse()

Constructs a new WriteFileRecordResponse instance.

Method Detail

getResponseSize

public int getResponseSize()

getRequestSize -- return the total request size. This is useful for determining if a new record can be added.

Returns:

size in bytes of response.

getRequestCount

public int getRequestCount()

getRequestCount -- return the number of record requests in this message.

Returns:

the number of record requests in this message

getRecord

public WriteFileRecordResponse.RecordResponse getRecord(int index)

getRecord -- return the record request indicated by the reference

Parameters:

index - Record to get

Returns:

the record request indicated by the reference

addResponse

public void addResponse(WriteFileRecordResponse.RecordResponse response)

addResponse -- add a new record response.

Parameters:

response - Add record response

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