com.ghgande.j2mod.modbus.msg

Class ReadSerialDiagnosticsRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsRequest

All Implemented Interfaces:

ModbusMessage

public class ReadSerialDiagnosticsRequest
extends ModbusRequest

Class implementing a ReadSerialDiagnosticsRequest.

Version:

2.0 (March 2016)

Author:

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

Constructor Summary

Constructors

Constructor and Description
ReadSerialDiagnosticsRequest() Constructs a new Diagnostics request instance.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
int	getData() getData
int	getData(int index) Deprecated.
int	getFunction() getFunction -- Get the DIAGNOSTICS sub-function.
byte[]	getMessage() getMessage -- Create the DIAGNOSTICS message paylaod.
ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.
int	getWordCount() getWordCount -- get the number of words in data.
void	readData(DataInput din) readData -- Read the function code and data value
void	setData(int value) setData -- Set the optional data value
void	setData(int index, int value) Deprecated.
void	setFunction(int function) setFunction - Set the DIAGNOSTICS sub-function.
void	writeData(DataOutput dout) writeData -- output the completed 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

ReadSerialDiagnosticsRequest

public ReadSerialDiagnosticsRequest()

Constructs a new Diagnostics request instance.

Method Detail

getFunction

public int getFunction()

getFunction -- Get the DIAGNOSTICS sub-function.

Returns:

int

setFunction

public void setFunction(int function)

setFunction - Set the DIAGNOSTICS sub-function.

Parameters:

function - - DIAGNOSTICS command sub-function.

getWordCount

public int getWordCount()

getWordCount -- get the number of words in data.

Returns:

Number of words in the data

getData

public int getData()

getData

Returns:

the first data item

setData

public void setData(int value)

setData -- Set the optional data value

Parameters:

value - Diagnostics value

getData

@Deprecated
public int getData(int index)

Deprecated.

getData -- Get the data item at the index.

Parameters:

index - - Unused, must be 0.

Returns:

Data at index 0

setData

@Deprecated
public void setData(int index,
                                 int value)

Deprecated.

setData -- Set the data item at the index

Parameters:

index - - Unused, must be 0.

value - - Optional data value for function.

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 the completed 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 -- Read the function code and data value

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 -- Create the DIAGNOSTICS message paylaod.

Returns:

Response as byte array