com.ghgande.j2mod.modbus.msg

Class ReadCoilsResponse

java.lang.Object

com.ghgande.j2mod.modbus.msg.ModbusMessageImpl

com.ghgande.j2mod.modbus.msg.ModbusResponse

com.ghgande.j2mod.modbus.msg.ReadCoilsResponse

All Implemented Interfaces:

ModbusMessage

public class ReadCoilsResponse
extends ModbusResponse

Completed re-implementation 1/10/2011 Created getMessage() method to abstractly create the message data. Cleaned up the constructors.

Version:

2.0 (March 2016)

Author:

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
ReadCoilsResponse() ReadCoilsResponse -- create an empty response message to be filled in later.
ReadCoilsResponse(int count) ReadCoilsResponse -- create a response for a given number of coils.

Method Summary

Modifier and Type	Method and Description
int	getBitCount() getBitCount -- return the number of coils
BitVector	getCoils() getCoils -- get the coils bit vector.
boolean	getCoilStatus(int index) Convenience method that returns the state of the bit at the given index.
byte[]	getMessage() Returns the raw message as an array of bytes.
void	readData(DataInput input) Reads the subclass specific data from the given DataInput instance.
void	setCoilStatus(int index, boolean b) Sets the status of the given coil.
void	writeData(DataOutput output) 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

ReadCoilsResponse

public ReadCoilsResponse()

ReadCoilsResponse -- create an empty response message to be filled in later.

ReadCoilsResponse

public ReadCoilsResponse(int count)

ReadCoilsResponse -- create a response for a given number of coils.

Parameters:

count - the number of bits to be read.

Method Detail

getBitCount

public int getBitCount()

getBitCount -- return the number of coils

Returns:

number of defined coils

getCoils

public BitVector getCoils()

getCoils -- get the coils bit vector. The coils vector may be read (when operating as a master) or written (when operating as a slave).

Returns:

BitVector containing the coils.

getCoilStatus

public boolean getCoilStatus(int index)
                      throws IndexOutOfBoundsException

Convenience method that returns the state of the bit at the given index.

Parameters:

index - the index of the coil for which the status should be returned.

Returns:

true if set, false otherwise.

Throws:

IndexOutOfBoundsException - if the index is out of bounds

setCoilStatus

public void setCoilStatus(int index,
                          boolean b)

Sets the status of the given coil.

Parameters:

index - the index of the coil to be set.

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

writeData

public void writeData(DataOutput output)
               throws IOException

Description copied from class: ModbusMessageImpl

Writes the subclass specific data to the given DataOutput.

Specified by:

writeData in class ModbusMessageImpl

Parameters:

output - the DataOutput to be written to.

Throws:

IOException - if an I/O related error occurs.

readData

public void readData(DataInput input)
              throws IOException

Description copied from class: ModbusMessageImpl

Reads the subclass specific data from the given DataInput instance.

Specified by:

readData in class ModbusMessageImpl

Parameters:

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