com.ghgande.j2mod.modbus.msg

Class WriteCoilResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.WriteCoilResponse

All Implemented Interfaces:

ModbusMessage

public class WriteCoilResponse
extends ModbusResponse

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

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, 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
WriteCoilResponse() Constructs a new WriteCoilResponse instance.
WriteCoilResponse(int reference, boolean b) Constructs a new WriteCoilResponse instance.

Method Summary

Modifier and Type	Method and Description
boolean	getCoil() Gets the state that has been returned in 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 has been written to with the request.
void	readData(DataInput din) Reads the subclass specific data from the given DataInput instance.
void	setCoil(boolean b) Sets the state that has been returned in the raw response.
void	setReference(int ref) Sets the reference of the register of the coil that has been written to with the request.
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

WriteCoilResponse

public WriteCoilResponse()

Constructs a new WriteCoilResponse instance.

WriteCoilResponse

public WriteCoilResponse(int reference,
                         boolean b)

Constructs a new WriteCoilResponse instance.

Parameters:

reference - the offset were writing was started from.

b - the state of the coil; true set, false reset.

Method Detail

getCoil

public boolean getCoil()

Gets the state that has been returned in this WriteCoilRequest.

Returns:

true if the coil is set, false if unset.

setCoil

public void setCoil(boolean b)

Sets the state that has been returned in the raw response.

Parameters:

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

getReference

public int getReference()

Returns the reference of the register of the coil that has been written to with the request.

Returns:

the reference of the coil's register.

setReference

public void setReference(int ref)

Sets the reference of the register of the coil that has been written to with the request.

Parameters:

ref - the reference of the coil's register.

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