com.ghgande.j2mod.modbus.msg

Class MaskWriteRegisterResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.MaskWriteRegisterResponse

All Implemented Interfaces:

ModbusMessage

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

Method Summary

Modifier and Type	Method and Description
int	getAndMask() getAndMask -- return the AND mask value;
byte[]	getMessage() getMessage -- format the message into a byte array.
int	getOrMask() getOrMask -- return the OR mask value;
int	getReference() getReference
void	readData(DataInput din) readData -- input the Modbus message from din.
void	setAndMask(int mask) setAndMask -- set AND mask
void	setOrMask(int mask) setOrMask -- set OR mask
void	setReference(int ref) setReference -- set the reference field.
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

MaskWriteRegisterResponse

public MaskWriteRegisterResponse()

Constructs a new ReportSlaveIDResponse instance.

Method Detail

getReference

public int getReference()

getReference

Returns:

the reference field

setReference

public void setReference(int ref)

setReference -- set the reference field.

Parameters:

ref - Register value

getAndMask

public int getAndMask()

getAndMask -- return the AND mask value;

Returns:

int

setAndMask

public void setAndMask(int mask)

setAndMask -- set AND mask

Parameters:

mask - Mask to use

getOrMask

public int getOrMask()

getOrMask -- return the OR mask value;

Returns:

int

setOrMask

public void setOrMask(int mask)

setOrMask -- set OR mask

Parameters:

mask - OR bit mask

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 to the socket/port

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 from the socket/port

getMessage

public byte[] getMessage()

getMessage -- format the message into a byte array.

Returns:

Byte array of the message