jamod at SF

net.wimpi.modbus.msg
Class ReadCoilsRequest

java.lang.Object
  extended bynet.wimpi.modbus.msg.ModbusMessageImpl
      extended bynet.wimpi.modbus.msg.ModbusRequest
          extended bynet.wimpi.modbus.msg.ReadCoilsRequest
All Implemented Interfaces:
ModbusMessage, Transportable

public final class ReadCoilsRequest
extends ModbusRequest

Class implementing a ReadCoilsRequest. The implementation directly correlates with the class 1 function read coils (FC 1). It encapsulates the corresponding request message.

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

Version:
1.2rc1 (09/11/2004)
Author:
Dieter Wimberger

Constructor Summary
ReadCoilsRequest()
          Constructs a new ReadCoilsRequest instance.
ReadCoilsRequest(int ref, int count)
          Constructs a new ReadCoilsRequest instance with a given reference and count of coils (i.e. bits) to be read.
 
Method Summary
 ModbusResponse createResponse()
          Returns the ModbusResponse that represents the answer to this ModbusRequest.
 int getBitCount()
          Returns the number of bits (i.e. coils) to be read with this ReadCoilsRequest.
 int getReference()
          Returns the reference of the register to to start reading from with this ReadCoilsRequest.
 void readData(java.io.DataInput din)
          Reads the subclass specific data from the given DataInput instance.
 void setBitCount(int count)
          Sets the number of bits (i.e. coils) to be read with this ReadCoilsRequest.
 void setReference(int ref)
          Sets the reference of the register to start reading from with this ReadCoilsRequest.
 void writeData(java.io.DataOutput dout)
          Writes the subclass specific data to the given DataOutput.
 
Methods inherited from class net.wimpi.modbus.msg.ModbusRequest
createExceptionResponse, createModbusRequest
 
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
 

Constructor Detail

ReadCoilsRequest

public ReadCoilsRequest()
Constructs a new ReadCoilsRequest instance.


ReadCoilsRequest

public ReadCoilsRequest(int ref,
                        int count)
Constructs a new ReadCoilsRequest instance with a given reference and count of coils (i.e. bits) to be read.

Parameters:
ref - the reference number of the register to read from.
count - the number of bits to be read.
Method Detail

createResponse

public ModbusResponse createResponse()
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.

Specified by:
createResponse in class ModbusRequest
Returns:
the corresponding ModbusResponse.

setReference

public void setReference(int ref)
Sets the reference of the register to start reading from with this ReadCoilsRequest.

Parameters:
ref - the reference of the register to start reading from.

getReference

public int getReference()
Returns the reference of the register to to start reading from with this ReadCoilsRequest.

Returns:
the reference of the register to start reading from as int.

setBitCount

public void setBitCount(int count)
Sets the number of bits (i.e. coils) to be read with this ReadCoilsRequest.

Parameters:
count - the number of bits to be read.

getBitCount

public int getBitCount()
Returns the number of bits (i.e. coils) to be read with this ReadCoilsRequest.

Returns:
the number of bits to be read.

writeData

public void writeData(java.io.DataOutput dout)
               throws java.io.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:
java.io.IOException - if an I/O related error occurs.

readData

public void readData(java.io.DataInput din)
              throws java.io.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:
java.io.IOException - if an I/O related error occurs.

jamod at SF

Copyright © 2002-2004 jamod development team.