com.ergotech.vib.servers.modbus.slave

Class BlockProcessImage

java.lang.Object

com.ergotech.vib.servers.modbus.slave.BlockProcessImage

public class BlockProcessImage
extends java.lang.Object

This process image is designed to allow a system to simulate the memory address space of a PLC. It is intended to be a stand-alone image and to be written and read by external sources. It supports inputs (1x) and input registers (3x) but since these must be written by external (modbus) calls Coils and Inputs overlap (0x and 1x) as do input register and registers (3x and 4x). This means that writing a 4x or a 0x register will change the value of a corresponding 3x or 1x register. It follows logically from this that the number of 3x and 4x registers as well as the number of 0x and 1x register must be the same. This process image will respond to any request up to the maximums provided in the constructor. Components to handle the requests will be created lazily as a register is accessed.

Constructor Summary

Constructors

Constructor and Description
BlockProcessImage(int maxOutputs, int maxRegisters, int regNotifyMin, int regNotifyMax, int coilNotifyMin, int coilNotifyMax, int unitId, ModbusSlaveBase modbusSlave) Constructs a new LazyProcessImage instance.

Method Summary

Modifier and Type	Method and Description
void	addDigitalIn(DigitalIn di)
void	addDigitalOut(DigitalOut _do)
void	addInputRegister(InputRegister inputRegister)
void	addRegister(Register reg)
int	getCoilCount()
int	getCoilNotifyMax()
int	getCoilNotifyMin()
DigitalIn	getDigitalIn(int ref)
int	getDigitalInCount()
DigitalIn[]	getDigitalInRange(int ref, int count)
DigitalOut	getDigitalOut(int ref)
int	getDigitalOutCount()
DigitalOut[]	getDigitalOutRange(int ref, int count)
InputRegister	getInputRegister(int ref)
int	getInputRegisterCount()
InputRegister[]	getInputRegisterRange(int ref, int count)
Register	getRegister(int ref)
int	getRegisterCount()
Register[]	getRegisterRange(int ref, int count)
int	getRegNotifyMax()
int	getRegNotifyMin()
int	getUnitId()
void	removeDigitalIn(DigitalIn di)
void	removeDigitalOut(DigitalOut _do)
void	removeInputRegister(InputRegister reg)
void	removeRegister(Register reg)
void	setCoilNotifyMax(int coilNotifyMax)
void	setCoilNotifyMin(int coilNotifyMin)
void	setDigitalIn(int ref, DigitalIn di)
void	setDigitalOut(int ref, DigitalOut _do)
void	setInputRegister(int ref, InputRegister inputRegister)
void	setRegister(int ref, Register reg)
void	setRegNotifyMax(int regNotifyMax)
void	setRegNotifyMin(int regNotifyMin)
void	setUnitId(int unitId)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockProcessImage

public BlockProcessImage(int maxOutputs,
                         int maxRegisters,
                         int regNotifyMin,
                         int regNotifyMax,
                         int coilNotifyMin,
                         int coilNotifyMax,
                         int unitId,
                         ModbusSlaveBase modbusSlave)

Constructs a new LazyProcessImage instance. This creates the arrays in an unpopulated form. The notification parameters are also set. These may be -1 to disable notification.

Parameters:

maxOutputs - the highest coil

maxRegisters - the highest register

regNotifyMin - any change in a coil value between this coil and the max will cause a notification to be sent to the slave

regNotifyMax - any change in a coil value between this coil and the max will cause a notification to be sent to the slave

coilNotifyMin - any change in a coil value between this coil and the max will cause a notification to be sent to the slave

coilNotifyMax - any change in a coil value between this coil and the max will cause a notification to be sent to the slave

unitId - the unit (station) id - required for notification

modbusSlave - the modbus slave that the process image was created for

Method Detail

addDigitalIn

public void addDigitalIn(DigitalIn di)

addDigitalOut

public void addDigitalOut(DigitalOut _do)

addInputRegister

public void addInputRegister(InputRegister inputRegister)

addRegister

public void addRegister(Register reg)

getCoilCount

public int getCoilCount()

getCoilNotifyMax

public int getCoilNotifyMax()

Returns:

Returns the coilNotifyMax.

getCoilNotifyMin

public int getCoilNotifyMin()

Returns:

Returns the coilNotifyMin.

getDigitalIn

public DigitalIn getDigitalIn(int ref)
                       throws IllegalAddressException

Throws:

IllegalAddressException

getDigitalInCount

public int getDigitalInCount()

getDigitalInRange

public DigitalIn[] getDigitalInRange(int ref,
                                     int count)

getDigitalOut

public DigitalOut getDigitalOut(int ref)
                         throws IllegalAddressException

Throws:

IllegalAddressException

getDigitalOutCount

public int getDigitalOutCount()

getDigitalOutRange

public DigitalOut[] getDigitalOutRange(int ref,
                                       int count)

getInputRegister

public InputRegister getInputRegister(int ref)
                               throws IllegalAddressException

Throws:

IllegalAddressException

getInputRegisterCount

public int getInputRegisterCount()

getInputRegisterRange

public InputRegister[] getInputRegisterRange(int ref,
                                             int count)

getRegister

public Register getRegister(int ref)
                     throws IllegalAddressException

Throws:

IllegalAddressException

getRegisterCount

public int getRegisterCount()

getRegisterRange

public Register[] getRegisterRange(int ref,
                                   int count)

getRegNotifyMax

public int getRegNotifyMax()

Returns:

Returns the regNotifyMax.

getRegNotifyMin

public int getRegNotifyMin()

Returns:

Returns the regNotifyMin.

getUnitId

public int getUnitId()

Returns:

Returns the unitId.

removeDigitalIn

public void removeDigitalIn(DigitalIn di)

removeDigitalOut

public void removeDigitalOut(DigitalOut _do)

removeInputRegister

public void removeInputRegister(InputRegister reg)

removeRegister

public void removeRegister(Register reg)

setCoilNotifyMax

public void setCoilNotifyMax(int coilNotifyMax)

Parameters:

coilNotifyMax - The coilNotifyMax to set.

setCoilNotifyMin

public void setCoilNotifyMin(int coilNotifyMin)

Parameters:

coilNotifyMin - The coilNotifyMin to set.

setDigitalIn

public void setDigitalIn(int ref,
                         DigitalIn di)
                  throws IllegalAddressException

Throws:

IllegalAddressException

setDigitalOut

public void setDigitalOut(int ref,
                          DigitalOut _do)
                   throws IllegalAddressException

Throws:

IllegalAddressException

setInputRegister

public void setInputRegister(int ref,
                             InputRegister inputRegister)
                      throws IllegalAddressException

Throws:

IllegalAddressException

setRegister

public void setRegister(int ref,
                        Register reg)
                 throws IllegalAddressException

Throws:

IllegalAddressException

setRegNotifyMax

public void setRegNotifyMax(int regNotifyMax)

Parameters:

regNotifyMax - The regNotifyMax to set.

setRegNotifyMin

public void setRegNotifyMin(int regNotifyMin)

Parameters:

regNotifyMin - The regNotifyMin to set.

setUnitId

public void setUnitId(int unitId)

Parameters:

unitId - The unitId to set.