com.ghgande.j2mod.modbus.msg

Class WriteFileRecordRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.WriteFileRecordRequest

All Implemented Interfaces:

ModbusMessage

public class WriteFileRecordRequest
extends ModbusRequest

Class implementing a Write File Record request.

Version:

2.0 (March 2016)

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteFileRecordRequest.RecordRequest

Constructor Summary

Constructors

Constructor and Description
WriteFileRecordRequest() Constructs a new Write File Record request instance.

Method Summary

Modifier and Type	Method and Description
void	addRequest(WriteFileRecordRequest.RecordRequest request) addRequest -- add a new record request.
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
byte[]	getMessage() getMessage -- return the raw binary message.
WriteFileRecordRequest.RecordRequest	getRecord(int reference) getRecord -- return the record request indicated by the reference
int	getRequestCount() getRequestCount -- return the number of record requests in this message.
int	getRequestSize() getRequestSize -- return the total request size.
ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.
void	readData(DataInput din) readData -- convert the byte stream into a request.
void	writeData(DataOutput dout) writeData -- output this Modbus message to dout.

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

WriteFileRecordRequest

public WriteFileRecordRequest()

Constructs a new Write File Record request instance.

Method Detail

getRequestSize

public int getRequestSize()

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:

number of record requests in this message

getRecord

public WriteFileRecordRequest.RecordRequest getRecord(int reference)

getRecord -- return the record request indicated by the reference

Parameters:

reference - Register reference

Returns:

the record request indicated by the reference

addRequest

public void addRequest(WriteFileRecordRequest.RecordRequest request)

addRequest -- add a new record request.

Parameters:

request - Request record

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.

writeData

public void writeData(DataOutput dout)
               throws IOException

writeData -- output this Modbus message to dout.

Specified by:

writeData in class ModbusMessageImpl

Parameters:

dout - the DataOutput to be written to.

Throws:

IOException - If the data cannot be written

readData

public void readData(DataInput din)
              throws IOException

readData -- convert the byte stream into a request.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - the DataInput to read from.

Throws:

IOException - If the data cannot be read

getMessage

public byte[] getMessage()

getMessage -- return the raw binary message.

Returns:

the raw binary message