com.ghgande.j2mod.modbus.msg

Class WriteCoilRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.WriteCoilRequest

All Implemented Interfaces:

ModbusMessage

public class WriteCoilRequest
extends ModbusRequest

Class implementing a WriteCoilRequest. The implementation directly correlates with the class 0 function write coil (FC 5). It encapsulates the corresponding request message.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
WriteCoilRequest() Constructs a new WriteCoilRequest instance.
WriteCoilRequest(int ref, boolean b) Constructs a new WriteCoilRequest instance with a given reference and state to be written.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
boolean	getCoil() Returns the state that should be written with this WriteCoilRequest.
byte[]	getMessage() Returns the raw message as an array of bytes.
int	getReference() Returns the reference of the register of the coil that should be written to with this ReadCoilsRequest.
ModbusResponse	getResponse() Returns the ModbusResponse that correlates with this ModbusRequest.
void	readData(DataInput din) Reads the subclass specific data from the given DataInput instance.
void	setCoil(boolean b) Sets the state that should be written with this WriteCoilRequest.
void	setReference(int ref) Sets the reference of the register of the coil that should be written to with this ReadCoilsRequest.
void	writeData(DataOutput dout) Writes the subclass specific data to the given DataOutput.

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

WriteCoilRequest

public WriteCoilRequest()

Constructs a new WriteCoilRequest instance.

WriteCoilRequest

public WriteCoilRequest(int ref,
                        boolean b)

Constructs a new WriteCoilRequest instance with a given reference and state to be written.

Parameters:

ref - the reference number of the register to read from.

b - true if the coil should be set of false if it should be unset.

Method Detail

getResponse

public ModbusResponse getResponse()

Description copied from class: ModbusRequest

Returns the ModbusResponse that correlates with this ModbusRequest.

The response must include the unit number, function code, as well as any transport-specific header information.

This method is used to create an empty response which must be populated by the caller. It is commonly used to un-marshal responses from Modbus slaves.

Specified by:

getResponse in class ModbusRequest

Returns:

the corresponding ModbusResponse.

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.

getReference

public int getReference()

Returns the reference of the register of the coil that should be written to with this ReadCoilsRequest.

Returns:

the reference of the coil's register.

setReference

public void setReference(int ref)

Sets the reference of the register of the coil that should be written to with this ReadCoilsRequest.

Parameters:

ref - the reference of the coil's register.

getCoil

public boolean getCoil()

Returns the state that should be written with this WriteCoilRequest.

Returns:

true if the coil should be set of false if it should be unset.

setCoil

public void setCoil(boolean b)

Sets the state that should be written with this WriteCoilRequest.

Parameters:

b - true if the coil should be set of false if it should be unset.

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[].