net.wimpi.modbus.msg
Class WriteCoilResponse

java.lang.Object
  net.wimpi.modbus.msg.ModbusMessageImpl
      net.wimpi.modbus.msg.ModbusResponse
          net.wimpi.modbus.msg.WriteCoilResponse

All Implemented Interfaces:

Transportable, ModbusMessage

public final 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:

1.2 (@date@)

Author:

Dieter Wimberger

Field Summary

private boolean	m_Coil
private int	m_Reference

Constructor Summary

WriteCoilResponse()
Constructs a new WriteCoilResponse instance.

WriteCoilResponse(int reference, boolean b)
Constructs a new WriteCoilResponse instance.

Method Summary

boolean	getCoil() Gets the state that has been returned in this WriteCoilRequest.
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.
private void	setCoil(boolean b) Sets the state that has been returned in the raw response.
private 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 net.wimpi.modbus.msg.ModbusResponse

createModbusResponse, setMessage

Methods inherited from class net.wimpi.modbus.msg.ModbusMessageImpl

getDataLength, getFunctionCode, getHexMessage, getOutputLength, getProtocolID, getTransactionID, getUnitID, isHeadless, readFrom, setDataLength, setFunctionCode, setHeadless, setHeadless, setProtocolID, setTransactionID, setUnitID, writeTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_Coil

private boolean m_Coil

m_Reference

private int m_Reference

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

setCoil

private 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.

getCoil

public boolean getCoil()

Gets the state that has been returned in this WriteCoilRequest.

Returns:

true if the coil is set, false if 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

private 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.