com.ghgande.j2mod.modbus.msg

Class ExceptionResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.ExceptionResponse

All Implemented Interfaces:

ModbusMessage

Direct Known Subclasses:

IllegalAddressExceptionResponse, IllegalFunctionExceptionResponse, IllegalValueExceptionResponse

public class ExceptionResponse
extends ModbusResponse

Class implementing aModbusResponse that represents an exception.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, 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
ExceptionResponse() Constructs a new ExceptionResponse instance with no function or exception code.
ExceptionResponse(int fc) Constructs a new ExceptionResponse instance with a given function code.
ExceptionResponse(int fc, int exc) Constructs a new ExceptionResponse instance with a given function code and an exception code.

Method Summary

Modifier and Type	Method and Description
int	getExceptionCode() Returns the Modbus exception code of this ExceptionResponse.
byte[]	getMessage() getMessage() return the exception type, which is the "message" for this response.
void	readData(DataInput din) readData() read the single byte of data, which is the exception code.
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

ExceptionResponse

public ExceptionResponse(int fc,
                         int exc)

Constructs a new ExceptionResponse instance with a given function code and an exception code. The function code will be automatically increased with the exception offset.

Parameters:

fc - the function code as int.

exc - the exception code as int.

ExceptionResponse

public ExceptionResponse(int fc)

Constructs a new ExceptionResponse instance with a given function code. ORs the exception offset automatically.

Parameters:

fc - the function code as int.

ExceptionResponse

public ExceptionResponse()

Constructs a new ExceptionResponse instance with no function or exception code.

Method Detail

getExceptionCode

public int getExceptionCode()

Returns the Modbus exception code of this ExceptionResponse.

Returns:

the exception code as int.

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

readData() read the single byte of data, which is the exception code.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - the DataInput to read from.

Throws:

IOException - If the data cannot be read from the socket/port

getMessage

public byte[] getMessage()

getMessage() return the exception type, which is the "message" for this response.

Returns:

-- byte array containing the 1 byte exception code.