com.ghgande.j2mod.modbus.msg

Class ModbusResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

All Implemented Interfaces:

ModbusMessage

Direct Known Subclasses:

ExceptionResponse, MaskWriteRegisterResponse, ReadCoilsResponse, ReadCommEventCounterResponse, ReadCommEventLogResponse, ReadExceptionStatusResponse, ReadFIFOQueueResponse, ReadFileRecordResponse, ReadInputDiscretesResponse, ReadInputRegistersResponse, ReadMEIResponse, ReadMultipleRegistersResponse, ReadSerialDiagnosticsResponse, ReadWriteMultipleResponse, ReportSlaveIDResponse, WriteCoilResponse, WriteFileRecordResponse, WriteMultipleCoilsResponse, WriteMultipleRegistersResponse, WriteSingleRegisterResponse

public abstract class ModbusResponse
extends ModbusMessageImpl

Abstract class implementing a ModbusResponse. This class provides specialised implementations with the functionality they have in common.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Julie Haugh, Steve O'Hara (4NG)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModbusResponse.AuxiliaryMessageTypes

Constructor Summary

Constructors

Constructor and Description
ModbusResponse()

Method Summary

Modifier and Type	Method and Description
static ModbusResponse	createModbusResponse(int functionCode) Factory method creating the required specialized ModbusResponse instance.
ModbusResponse.AuxiliaryMessageTypes	getAuxiliaryType() Returns the auxiliary type of this response message Useful for adding extra information to the message that can be used by downstream processing
void	setAuxiliaryType(ModbusResponse.AuxiliaryMessageTypes auxiliaryType) Sets the auxiliary type of this response

Methods inherited from class com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

getDataLength, getFunctionCode, getHexMessage, getOutputLength, getProtocolID, getTransactionID, getUnitID, isHeadless, readData, readFrom, setDataLength, setHeadless, setHeadless, setProtocolID, setTransactionID, setUnitID, writeData, writeTo

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ghgande.j2mod.modbus.msg.ModbusMessage

getMessage

Constructor Detail

ModbusResponse

public ModbusResponse()

Method Detail

createModbusResponse

public static ModbusResponse createModbusResponse(int functionCode)

Factory method creating the required specialized ModbusResponse instance.

Parameters:

functionCode - the function code of the response as int.

Returns:

a ModbusResponse instance specific for the given function code.

getAuxiliaryType

public ModbusResponse.AuxiliaryMessageTypes getAuxiliaryType()

Returns the auxiliary type of this response message Useful for adding extra information to the message that can be used by downstream processing

Returns:

Auxiliary type

setAuxiliaryType

public void setAuxiliaryType(ModbusResponse.AuxiliaryMessageTypes auxiliaryType)

Sets the auxiliary type of this response

Parameters:

auxiliaryType - Type