com.ghgande.j2mod.modbus.msg

Class WriteMultipleCoilsRequest

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusRequest

com.ghgande.j2mod.modbus.msg.WriteMultipleCoilsRequest

All Implemented Interfaces:

ModbusMessage

public class WriteMultipleCoilsRequest
extends ModbusRequest

Class implementing a WriteMultipleCoilsRequest. The implementation directly correlates with the class 1 function write multiple coils (FC 15). It encapsulates the corresponding request 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)

Constructor Summary

Constructors

Constructor and Description
WriteMultipleCoilsRequest() Constructs a new WriteMultipleCoilsRequest instance.
WriteMultipleCoilsRequest(int ref, BitVector bv) Constructs a new WriteMultipleCoilsRequest instance with the given reference and coil values.
WriteMultipleCoilsRequest(int ref, int count) Constructs a new WriteMultipleCoilsRequest instance with a given reference and count of coils to be written, followed by the actual byte count, and then count number of bytes.

Method Summary

Modifier and Type	Method and Description
ModbusResponse	createResponse(AbstractModbusListener listener) Returns the ModbusResponse that represents the answer to this ModbusRequest.
int	getBitCount() getBitCount - Returns the number of coils written with the request.
int	getByteCount() getByteCount - Returns the number of bytes required for packing the coils.
BitVector	getCoils() getCoils - Returns the BitVector instance holding coil status information.
boolean	getCoilStatus(int index) getCoilStatus - Returns the status of the specified coil.
byte[]	getMessage() Returns the raw message as an array of bytes.
int	getReference() getReference - Returns the reference of the coil to to start writing to with this WriteMultipleCoilsRequest.
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	setCoils(BitVector bv) setCoils - Sets the BitVector instance holding coil status information.
void	setCoilStatus(int index, boolean b) setCoilStatus - Sets the status of the specified coil.
void	setReference(int ref) setReference - Sets the reference of the coil to start writing to with this WriteMultipleCoilsRequest.
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

WriteMultipleCoilsRequest

public WriteMultipleCoilsRequest(int ref,
                                 BitVector bv)

Constructs a new WriteMultipleCoilsRequest instance with the given reference and coil values.

Parameters:

ref - the index of the first coil to be written.

bv - the coil values to be written.

WriteMultipleCoilsRequest

public WriteMultipleCoilsRequest(int ref,
                                 int count)

Constructs a new WriteMultipleCoilsRequest instance with a given reference and count of coils to be written, followed by the actual byte count, and then count number of bytes.

Parameters:

ref - the index of the first coil to be written.

count - the number of coils to be written.

WriteMultipleCoilsRequest

public WriteMultipleCoilsRequest()

Constructs a new WriteMultipleCoilsRequest instance.

A minimal message contains the reference to the first coil as a short, the number of coils as a short, and not less than one byte of coil data.

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()

getReference - Returns the reference of the coil to to start writing to with this WriteMultipleCoilsRequest.

Returns:

the reference of the coil to start writing to as an int.

setReference

public void setReference(int ref)

setReference - Sets the reference of the coil to start writing to with this WriteMultipleCoilsRequest.

Parameters:

ref - the reference of the coil to start writing to.

getBitCount

public int getBitCount()

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

Returns:

the number of coils that have been written.

getByteCount

public int getByteCount()

getByteCount - Returns the number of bytes required for packing the coils.

Returns:

the number of bytes required for packing the coils.

getCoilStatus

public boolean getCoilStatus(int index)
                      throws IndexOutOfBoundsException

getCoilStatus - Returns the status of the specified coil.

Parameters:

index - the index of the coil to be tested.

Returns:

true if set, false otherwise.

Throws:

IndexOutOfBoundsException - if the given index is out of bounds.

setCoilStatus

public void setCoilStatus(int index,
                          boolean b)
                   throws IndexOutOfBoundsException

setCoilStatus - Sets the status of the specified coil.

Parameters:

index - the index of the coil to be set/reset.

b - true if to be set, false for reset.

Throws:

IndexOutOfBoundsException - if the given index is out of bounds.

getCoils

public BitVector getCoils()

getCoils - Returns the BitVector instance holding coil status information.

Returns:

the coils status as a BitVector instance.

setCoils

public void setCoils(BitVector bv)

setCoils - Sets the BitVector instance holding coil status information.

Parameters:

bv - a BitVector instance holding coil status info.

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