com.ghgande.j2mod.modbus.msg

Class ReadMEIResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.ReadMEIResponse

All Implemented Interfaces:

ModbusMessage

public class ReadMEIResponse
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
ReadMEIResponse() Constructs a new ReadMEIResponse instance.

Method Summary

Modifier and Type	Method and Description
void	addField(int id, String text)
String	getField(int index) Convenience method that returns the field at the requested index
int	getFieldCount() Returns the number of fields read with the request.
int	getFieldId(int index) Convenience method that returns the field ID at the given index.
String[]	getFields() Returns the array of strings that were read
byte[]	getMessage() Returns the raw message as an array of bytes.
void	readData(DataInput din) Reads the subclass specific data from the given DataInput instance.
void	setFieldLevel(int level)
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

ReadMEIResponse

public ReadMEIResponse()

Constructs a new ReadMEIResponse instance.

Method Detail

getFieldCount

public int getFieldCount()

Returns the number of fields read with the request.

Returns:

the number of fields that have been read.

getFields

public String[] getFields()

Returns the array of strings that were read

Returns:

Array of the fields read

getField

public String getField(int index)
                throws IndexOutOfBoundsException

Convenience method that returns the field at the requested index

Parameters:

index - the index of the field which should be returned.

Returns:

requested field

Throws:

IndexOutOfBoundsException - if the index is out of bounds

getFieldId

public int getFieldId(int index)
               throws IndexOutOfBoundsException

Convenience method that returns the field ID at the given index.

Parameters:

index - the index of the field for which the ID should be returned.

Returns:

field ID

Throws:

IndexOutOfBoundsException - if the index is out of bounds

setFieldLevel

public void setFieldLevel(int level)

addField

public void addField(int id,
                     String text)

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

Description copied from class: ModbusMessageImpl

Reads the subclass specific data from the given DataInput instance.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - the DataInput to read from.

Throws:

IOException - if an I/O related error occurs.

getMessage

public byte[] getMessage()

Description copied from interface: ModbusMessage

Returns the raw message as an array of bytes.

Returns:

the raw message as byte[].