com.ghgande.j2mod.modbus.msg

Class ReadSerialDiagnosticsResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.ReadSerialDiagnosticsResponse

All Implemented Interfaces:

ModbusMessage

public class ReadSerialDiagnosticsResponse
extends ModbusResponse

Class implementing a ReadSerialDiagnosticsResponse.

Version:

2.0 (March 2016)

Author:

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

Nested Class Summary

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

ModbusResponse.AuxiliaryMessageTypes

Constructor Summary

Constructors

Constructor and Description
ReadSerialDiagnosticsResponse() Constructs a new Diagnostics response instance.

Method Summary

Modifier and Type	Method and Description
int	getData() getData
int	getData(int index) Deprecated.
int	getFunction() getFunction -- Get the DIAGNOSTICS sub-function.
byte[]	getMessage() getMessage -- Create the DIAGNOSTICS message paylaod.
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.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

ReadSerialDiagnosticsResponse

public ReadSerialDiagnosticsResponse()

Constructs a new Diagnostics response instance.

Method Detail

getFunction

public int getFunction()

getFunction -- Get the DIAGNOSTICS sub-function.

Returns:

Function code

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 - optional data 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.

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:

message paylaod