com.ghgande.j2mod.modbus.msg

Class ReadFIFOQueueRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.ReadFIFOQueueRequest

All Implemented Interfaces:

ModbusMessage

public class ReadFIFOQueueRequest
extends ModbusRequest

Class implementing a Read FIFO Queue request.

Version:

2.0 (March 2016)

Author:

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

Constructor Summary

Constructors

Constructor and Description
ReadFIFOQueueRequest() Constructs a new Read FIFO Queue request instance.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
byte[]	getMessage() getMessage
int	getReference() getReference -- get the queue register number.
ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.
void	readData(DataInput din) readData -- read the reference word.
void	setReference(int ref) setReference -- set the queue register number.
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

ReadFIFOQueueRequest

public ReadFIFOQueueRequest()

Constructs a new Read FIFO Queue request instance.

Method Detail

getReference

public int getReference()

getReference -- get the queue register number.

Returns:

int

setReference

public void setReference(int ref)

setReference -- set the queue register number.

Parameters:

ref - Register

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 cannot write

readData

public void readData(DataInput din)
              throws IOException

readData -- read the reference word.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - the DataInput to read from.

Throws:

IOException - If cannot read

getMessage

public byte[] getMessage()

getMessage

Returns:

an empty array as there is no data for this request