com.serotonin.modbus4j

Class BasicProcessImage

java.lang.Object

com.serotonin.modbus4j.BasicProcessImage

All Implemented Interfaces:

ProcessImage

public class BasicProcessImage
extends java.lang.Object
implements ProcessImage

Constructor Summary

Constructors

Constructor and Description
BasicProcessImage(int slaveId)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ProcessImageListener l)
boolean	getBit(int range, int offset, int bit)
boolean	getCoil(int offset) Returns the current value of the coil for the given offset.
byte	getExceptionStatus() Returns the current value of the exception status.
short	getHoldingRegister(int offset) Returns the current value of the holding register for the given offset.
boolean	getHoldingRegisterBit(int offset, int bit)
boolean	getInput(int offset) Returns the current value of the input for the given offset.
short	getInputRegister(int offset) Returns the current value of the input register for the given offset.
boolean	getInputRegisterBit(int offset, int bit)
short	getInvalidAddressValue()
java.lang.Number	getNumeric(int range, int offset, int dataType)
<T> T	getRegister(BaseLocator<T> locator)
byte[]	getReportSlaveIdData() Returns the data for the report slave id command.
int	getSlaveId()
java.lang.String	getString(int range, int offset, int dataType, int registerCount)
java.lang.String	getString(int range, int offset, int dataType, int registerCount, java.nio.charset.Charset charset)
boolean	isAllowInvalidAddress()
void	removeListener(ProcessImageListener l)
void	setAllowInvalidAddress(boolean allowInvalidAddress)
void	setBinary(int registerId, boolean value)
void	setBinary(int range, int offset, boolean value)
void	setBit(int range, int offset, int bit, boolean value)
void	setCoil(int offset, boolean value) Used internally for setting the value of the coil.
void	setExceptionStatus(byte exceptionStatus)
void	setHoldingRegister(int offset, short value) Used internally for setting the value of the holding register.
void	setHoldingRegister(int offset, short[] registers)
void	setHoldingRegisterBit(int offset, int bit, boolean value)
void	setInput(int offset, boolean value) Used internally for setting the value of the input.
void	setInputRegister(int offset, short value) Used internally for setting the value of the input register.
void	setInputRegister(int offset, short[] registers)
void	setInputRegisterBit(int offset, int bit, boolean value)
void	setInvalidAddressValue(short invalidAddressValue)
void	setNumeric(int range, int offset, int dataType, java.lang.Number value)
void	setNumeric(int registerId, int dataType, java.lang.Number value)
void	setString(int range, int offset, int dataType, int registerCount, java.nio.charset.Charset charset, java.lang.String s)
void	setString(int range, int offset, int dataType, int registerCount, java.lang.String s)
void	writeCoil(int offset, boolean value) Used to set the coil as a result of a write command from the master.
void	writeHoldingRegister(int offset, short value) Used to set the holding register as a result of a write command from the master.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicProcessImage

public BasicProcessImage(int slaveId)

Method Detail

getSlaveId

public int getSlaveId()

Specified by:

getSlaveId in interface ProcessImage

addListener

public void addListener(ProcessImageListener l)

removeListener

public void removeListener(ProcessImageListener l)

isAllowInvalidAddress

public boolean isAllowInvalidAddress()

setAllowInvalidAddress

public void setAllowInvalidAddress(boolean allowInvalidAddress)

getInvalidAddressValue

public short getInvalidAddressValue()

setInvalidAddressValue

public void setInvalidAddressValue(short invalidAddressValue)

setExceptionStatus

public void setExceptionStatus(byte exceptionStatus)

setBinary

public void setBinary(int registerId,
             boolean value)

setBinary

public void setBinary(int range,
             int offset,
             boolean value)

setNumeric

public void setNumeric(int registerId,
              int dataType,
              java.lang.Number value)

setNumeric

public void setNumeric(int range,
              int offset,
              int dataType,
              java.lang.Number value)

setString

public void setString(int range,
             int offset,
             int dataType,
             int registerCount,
             java.lang.String s)

setString

public void setString(int range,
             int offset,
             int dataType,
             int registerCount,
             java.nio.charset.Charset charset,
             java.lang.String s)

setHoldingRegister

public void setHoldingRegister(int offset,
                      short[] registers)

setInputRegister

public void setInputRegister(int offset,
                    short[] registers)

setBit

public void setBit(int range,
          int offset,
          int bit,
          boolean value)

setHoldingRegisterBit

public void setHoldingRegisterBit(int offset,
                         int bit,
                         boolean value)

setInputRegisterBit

public void setInputRegisterBit(int offset,
                       int bit,
                       boolean value)

getBit

public boolean getBit(int range,
             int offset,
             int bit)
               throws IllegalDataAddressException

Throws:

IllegalDataAddressException

getHoldingRegisterBit

public boolean getHoldingRegisterBit(int offset,
                            int bit)
                              throws IllegalDataAddressException

Throws:

IllegalDataAddressException

getInputRegisterBit

public boolean getInputRegisterBit(int offset,
                          int bit)
                            throws IllegalDataAddressException

Throws:

IllegalDataAddressException

getNumeric

public java.lang.Number getNumeric(int range,
                          int offset,
                          int dataType)
                            throws IllegalDataAddressException

Throws:

IllegalDataAddressException

getString

public java.lang.String getString(int range,
                         int offset,
                         int dataType,
                         int registerCount)
                           throws IllegalDataAddressException

Throws:

IllegalDataAddressException

getString

public java.lang.String getString(int range,
                         int offset,
                         int dataType,
                         int registerCount,
                         java.nio.charset.Charset charset)
                           throws IllegalDataAddressException

Throws:

IllegalDataAddressException

getRegister

public <T> T getRegister(BaseLocator<T> locator)
              throws IllegalDataAddressException

Throws:

IllegalDataAddressException

getCoil

public boolean getCoil(int offset)
                throws IllegalDataAddressException

Description copied from interface: ProcessImage

Returns the current value of the coil for the given offset.

Specified by:

getCoil in interface ProcessImage

Returns:

the value of the coil

Throws:

IllegalDataAddressException

setCoil

public void setCoil(int offset,
           boolean value)

Description copied from interface: ProcessImage

Used internally for setting the value of the coil.

Specified by:

setCoil in interface ProcessImage

writeCoil

public void writeCoil(int offset,
             boolean value)
               throws IllegalDataAddressException

Description copied from interface: ProcessImage

Used to set the coil as a result of a write command from the master.

Specified by:

writeCoil in interface ProcessImage

Throws:

IllegalDataAddressException

getInput

public boolean getInput(int offset)
                 throws IllegalDataAddressException

Description copied from interface: ProcessImage

Returns the current value of the input for the given offset.

Specified by:

getInput in interface ProcessImage

Returns:

the value of the input

Throws:

IllegalDataAddressException

setInput

public void setInput(int offset,
            boolean value)

Description copied from interface: ProcessImage

Used internally for setting the value of the input.

Specified by:

setInput in interface ProcessImage

getHoldingRegister

public short getHoldingRegister(int offset)
                         throws IllegalDataAddressException

Description copied from interface: ProcessImage

Returns the current value of the holding register for the given offset.

Specified by:

getHoldingRegister in interface ProcessImage

Returns:

the value of the register

Throws:

IllegalDataAddressException

setHoldingRegister

public void setHoldingRegister(int offset,
                      short value)

Description copied from interface: ProcessImage

Used internally for setting the value of the holding register.

Specified by:

setHoldingRegister in interface ProcessImage

writeHoldingRegister

public void writeHoldingRegister(int offset,
                        short value)
                          throws IllegalDataAddressException

Description copied from interface: ProcessImage

Used to set the holding register as a result of a write command from the master.

Specified by:

writeHoldingRegister in interface ProcessImage

Throws:

IllegalDataAddressException

getInputRegister

public short getInputRegister(int offset)
                       throws IllegalDataAddressException

Description copied from interface: ProcessImage

Returns the current value of the input register for the given offset.

Specified by:

getInputRegister in interface ProcessImage

Returns:

the value of the register

Throws:

IllegalDataAddressException

setInputRegister

public void setInputRegister(int offset,
                    short value)

Description copied from interface: ProcessImage

Used internally for setting the value of the input register.

Specified by:

setInputRegister in interface ProcessImage

getExceptionStatus

public byte getExceptionStatus()

Description copied from interface: ProcessImage

Returns the current value of the exception status.

Specified by:

getExceptionStatus in interface ProcessImage

Returns:

the current value of the exception status.

getReportSlaveIdData

public byte[] getReportSlaveIdData()

Description copied from interface: ProcessImage

Returns the data for the report slave id command.

Specified by:

getReportSlaveIdData in interface ProcessImage

Returns:

the data for the report slave id command.