com.ghgande.j2mod.modbus.msg

Class MaskWriteRegisterRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.MaskWriteRegisterRequest

All Implemented Interfaces:

ModbusMessage

public class MaskWriteRegisterRequest
extends ModbusRequest

Class implementing a Mask Write Register request.

Version:

2.0 (March 2016)

Author:

Julie Haugh (jfh@ghgande.com), jfhaugh (jfh@ghgande.com), Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
MaskWriteRegisterRequest() Constructs a new Mask Write Register request.
MaskWriteRegisterRequest(int ref, int andMask, int orMask) Constructs a new Mask Write Register request.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
int	getAndMask() getAndMask -- return the AND mask value;
byte[]	getMessage() getMessage -- return an empty array as there is no data for this request.
int	getOrMask() getOrMask -- return the OR mask value;
int	getReference() getReference
ModbusResponse	getResponse() getResponse -- create an empty response for this request.
void	readData(DataInput din) readData -- dummy function.
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 this Modbus message to dout.

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

createExceptionResponse, createModbusRequest

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

MaskWriteRegisterRequest

public MaskWriteRegisterRequest(int ref,
                                int andMask,
                                int orMask)

Constructs a new Mask Write Register request.

Parameters:

ref - Register

andMask - AND Mask to use

orMask - OR Mask to use

MaskWriteRegisterRequest

public MaskWriteRegisterRequest()

Constructs a new Mask Write Register request. 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 - the reference field

getAndMask

public int getAndMask()

getAndMask -- return the AND mask value;

Returns:

int

setAndMask

public void setAndMask(int mask)

setAndMask -- set AND mask

Parameters:

mask - AND mask

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 mask

getResponse

public ModbusResponse getResponse()

getResponse -- create an empty response for this request.

Specified by:

getResponse in class ModbusRequest

Returns:

empty response for this request

createResponse

public ModbusResponse createResponse(AbstractModbusListener listener)

Description copied from class: ModbusRequest

Returns the ModbusResponse that represents the answer to this ModbusRequest.

The implementation should take care about assembling the reply to this ModbusRequest.

This method is used to create responses from the process image associated with the listener. It is commonly used to implement Modbus slave instances.

Specified by:

createResponse in class ModbusRequest

Parameters:

listener - Listener that received the request

Returns:

the corresponding ModbusResponse.

writeData

public void writeData(DataOutput dout)
               throws IOException

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

readData

public void readData(DataInput din)
              throws IOException

readData -- dummy function. There is no data with the request.

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 an empty array as there is no data for this request.

Returns:

message payload