com.ghgande.j2mod.modbus.msg

Class ReportSlaveIDResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.ReportSlaveIDResponse

All Implemented Interfaces:

ModbusMessage

public class ReportSlaveIDResponse
extends ModbusResponse

Class implementing a ReadMEIResponse. Derived from similar class for Read Coils response.

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
ReportSlaveIDResponse() Constructs a new ReportSlaveIDResponse instance.

Method Summary

Modifier and Type	Method and Description
byte[]	getData() getData -- get the device-depending data for the slave.
byte[]	getMessage() getMessage -- format the message into a byte array.
int	getSlaveID() getSlaveID -- return the slave identifier field.
boolean	getStatus() getStatus -- get the slave's "run" status.
void	readData(DataInput din) readData -- input the Modbus message from din.
void	setData(byte[] data) setData -- initialize the slave's device dependent data when initializing a response.
void	setSlaveID(int unitID) setSlaveID -- initialize the slave identifier when constructing a response message.
void	setStatus(boolean b) setStatus -- initialize the slave's "run" status when constructing a response message.
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

ReportSlaveIDResponse

public ReportSlaveIDResponse()

Constructs a new ReportSlaveIDResponse instance.

Method Detail

getSlaveID

public int getSlaveID()

getSlaveID -- return the slave identifier field.

Returns:

slave identifier field

setSlaveID

public void setSlaveID(int unitID)

setSlaveID -- initialize the slave identifier when constructing a response message.

Parameters:

unitID - UnitID of the slave

getStatus

public boolean getStatus()

getStatus -- get the slave's "run" status.

Returns:

boolean

setStatus

public void setStatus(boolean b)

setStatus -- initialize the slave's "run" status when constructing a response message.

Parameters:

b - Status value

getData

public byte[] getData()

getData -- get the device-depending data for the slave.

Returns:

byte array

setData

public void setData(byte[] data)

setData -- initialize the slave's device dependent data when initializing a response.

Parameters:

data - byte array

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 -- input the Modbus message from din. If there was a header, such as for Modbus/TCP, it will have been read already.

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 -- format the message into a byte array.

Returns:

Byte array of message