com.ghgande.j2mod.modbus.msg

Class WriteMultipleCoilsResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsResponse

All Implemented Interfaces:

ModbusMessage

public class WriteMultipleCoilsResponse
extends ModbusResponse

Class implementing a WriteMultipleCoilsResponse. The implementation directly correlates with the class 1 function write multiple coils (FC 15). It encapsulates the corresponding response message.

Coils are understood as bits that can be manipulated (i.e. set or cleared).

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Julie Haugh, 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
WriteMultipleCoilsResponse() Constructs a new WriteMultipleCoilsResponse instance.
WriteMultipleCoilsResponse(int ref, int count) Constructs a new WriteMultipleCoilsResponse instance with a given count of coils and starting reference.

Method Summary

Modifier and Type	Method and Description
int	getBitCount() getBitCount - Returns the quantity of coils written with the request.
byte[]	getMessage() Returns the raw message as an array of bytes.
int	getReference() getReference - Returns the reference of the coil to start reading from with this WriteMultipleCoilsResponse.
void	readData(DataInput din) readData - Initialize the attribute values for this message from the input buffer.
void	setBitCount(int count) setBitCount - Sets the number of coils that will be in a response.
void	setReference(int ref) setReference - Sets the reference to the coil that is the first coil in this response.
void	writeData(DataOutput dout) writeData - Copy the attribute values for this message to the output buffer.

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

WriteMultipleCoilsResponse

public WriteMultipleCoilsResponse(int ref,
                                  int count)

Constructs a new WriteMultipleCoilsResponse instance with a given count of coils and starting reference.

Parameters:

ref - the offset to begin writing from.

count - the number of coils to be written.

WriteMultipleCoilsResponse

public WriteMultipleCoilsResponse()

Constructs a new WriteMultipleCoilsResponse instance.

Method Detail

getReference

public int getReference()

getReference - Returns the reference of the coil to start reading from with this WriteMultipleCoilsResponse.

Returns:

the reference of the coil to start reading from as int.

setReference

public void setReference(int ref)

setReference - Sets the reference to the coil that is the first coil in this response.

Parameters:

ref - Rgister address of coil

getBitCount

public int getBitCount()

getBitCount - Returns the quantity of coils written with the request.

Returns:

the quantity of coils that have been written.

setBitCount

public void setBitCount(int count)

setBitCount - Sets the number of coils that will be in a response.

Parameters:

count - the number of coils in the response.

writeData

public void writeData(DataOutput dout)
               throws IOException

writeData - Copy the attribute values for this message to the output buffer.

Specified by:

writeData in class ModbusMessageImpl

Parameters:

dout - the DataOutput to be written to.

Throws:

IOException - If the data cannot be written

readData

public void readData(DataInput din)
              throws IOException

readData - Initialize the attribute values for this message from the input buffer.

Specified by:

readData in class ModbusMessageImpl

Parameters:

din - the DataInput to read from.

Throws:

IOException - If the data cannot be read

getMessage

public byte[] getMessage()

Description copied from interface: ModbusMessage

Returns the raw message as an array of bytes.

Returns:

the raw message as byte[].