com.ghgande.j2mod.modbus.procimg

Class SimpleProcessImage

java.lang.Object

com.ghgande.j2mod.modbus.procimg.SimpleProcessImage

All Implemented Interfaces:

ProcessImage, ProcessImageImplementation

public class SimpleProcessImage
extends Object
implements ProcessImageImplementation

Class implementing a simple process image to be able to run unit tests or handle simple cases.

The image has a simple linear address space for, analog, digital and file objects. Holes may be created by adding a object with a reference after the last object reference of that type.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Julie Added support for files of records., Steve O'Hara (4NG)

Field Summary

Fields inherited from interface com.ghgande.j2mod.modbus.procimg.ProcessImageImplementation

DIG_FALSE, DIG_INVALID, DIG_TRUE

Constructor Summary

Constructors

Constructor and Description
SimpleProcessImage() Constructs a new SimpleProcessImage instance.
SimpleProcessImage(int unit) Constructs a new SimpleProcessImage instance having a (potentially) non-zero unit ID.

Method Summary

Modifier and Type	Method and Description
void	addDigitalIn(DigitalIn di) Adds a new DigitalIn instance.
void	addDigitalIn(int ref, DigitalIn d1) Adds a new DigitalIn instance at the given reference, possibly creating a hole between the last existing reference and the new object.
void	addDigitalOut(DigitalOut out) Adds a new DigitalOut instance.
void	addDigitalOut(int ref, DigitalOut dout) Adds a new DigitalOut instance at the given reference.
void	addFIFO(FIFO fifo) Adds a new FIFO instance.
void	addFIFO(int ref, FIFO newFIFO) Adds a new FIFO instance, possibly creating a hole between the last existing reference and the new object.
void	addFile(File newFile) Adds a new File instance.
void	addFile(int ref, File newFile) Adds a new File instance, possibly creating a hole between the last existing reference and the new object.
void	addInputRegister(InputRegister reg) Adds a new InputRegister instance.
void	addInputRegister(int ref, InputRegister inReg) Adds a new InputRegister instance, possibly creating a hole between the last existing reference and the new object.
void	addRegister(int ref, Register reg) Adds a new Register instance, possibly creating a hole between the last existing reference and the new object.
void	addRegister(Register reg) Adds a new Register instance.
DigitalIn	getDigitalIn(int ref) Returns the DigitalIn instance at the given reference.
int	getDigitalInCount() Returns the number of DigitalIn instances in this ProcessImage.
DigitalIn[]	getDigitalInRange(int ref, int count) Returns a range of DigitalIn instances.
DigitalOut	getDigitalOut(int ref) Returns the DigitalOut instance at the given reference.
int	getDigitalOutCount() Returns the number of DigitalOut instances in this ProcessImage.
DigitalOut[]	getDigitalOutRange(int ref, int count) Returns a range of DigitalOut instances.
FIFO	getFIFO(int fifoNumber) Returns the FIFO instance in the list of all FIFO objects in this ProcessImage.
FIFO	getFIFOByAddress(int ref) Returns the FIFO instance having the specified base address.
int	getFIFOCount() Returns the number of File instances in this ProcessImage.
File	getFile(int fileNumber) Returns the File instance at the given reference.
File	getFileByNumber(int ref) Returns the File instance having the specified file number.
int	getFileCount() Returns the number of File instances in this ProcessImage.
InputRegister	getInputRegister(int ref) Returns the InputRegister instance at the given reference.
int	getInputRegisterCount() Returns the number of InputRegister instances in this ProcessImage.
InputRegister[]	getInputRegisterRange(int ref, int count) Returns a range of InputRegister instances.
Register	getRegister(int ref) Returns the Register instance at the given reference.
int	getRegisterCount() Returns the number of Register instances in this ProcessImage.
Register[]	getRegisterRange(int ref, int count) Returns a range of Register instances.
int	getUnitID()
boolean	isLocked() The process image is locked to prevent changes.
void	removeDigitalIn(DigitalIn di) Removes a given DigitalIn instance.
void	removeDigitalOut(DigitalOut out) Removes a given DigitalOut instance.
void	removeFIFO(FIFO oldFIFO) Removes a given FIFO instance.
void	removeFile(File oldFile) Removes a given File instance.
void	removeInputRegister(InputRegister reg) Removes a given InputRegister instance.
void	removeRegister(Register reg) Removes a given Register instance.
void	setDigitalIn(int ref, DigitalIn di) Sets a new DigitalIn instance at the given reference.
void	setDigitalOut(int ref, DigitalOut out) Sets a new DigitalOut instance at the given reference.
void	setFIFO(int fifoNumber, FIFO fifo) Sets a new FIFO instance at the given reference.
void	setFile(int fileNumber, File file) Sets a new File instance at the given reference.
void	setInputRegister(int ref, InputRegister reg) Sets a new InputRegister instance at the given reference.
boolean	setLocked(boolean locked) setLocked -- lock or unlock the process image.
void	setRegister(int ref, Register reg) Sets a new Register instance at the given reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleProcessImage

public SimpleProcessImage()

Constructs a new SimpleProcessImage instance.

SimpleProcessImage

public SimpleProcessImage(int unit)

Constructs a new SimpleProcessImage instance having a (potentially) non-zero unit ID.

Parameters:

unit - Unit ID of this image

Method Detail

isLocked

public boolean isLocked()

The process image is locked to prevent changes.

Returns:

whether or not the process image is locked.

setLocked

public boolean setLocked(boolean locked)

setLocked -- lock or unlock the process image. It is an error (false return value) to attempt to lock the process image when it is already locked.

Compatability Note: jamod did not enforce this restriction, so it is being handled in a way which is backwards compatible. If you wish to determine if you acquired the lock, check the return value. If your code is still based on the jamod paradigm, you will ignore the return value and your code will function as before.

Parameters:

locked - True if the image is to be locked

Returns:

setting lock succeded

getUnitID

public int getUnitID()

getDigitalOutRange

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

Description copied from interface: ProcessImage

Returns a range of DigitalOut instances.

Specified by:

getDigitalOutRange in interface ProcessImage

Parameters:

ref - the start offset.

count - the amount of DigitalOut from the offset.

Returns:

an array of DigitalOut instances.

getDigitalOut

public DigitalOut getDigitalOut(int ref)
                         throws IllegalAddressException

Description copied from interface: ProcessImage

Returns the DigitalOut instance at the given reference.

Specified by:

getDigitalOut in interface ProcessImage

Parameters:

ref - the reference.

Returns:

the DigitalOut instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getDigitalOutCount

public int getDigitalOutCount()

Description copied from interface: ProcessImage

Returns the number of DigitalOut instances in this ProcessImage.

Specified by:

getDigitalOutCount in interface ProcessImage

Returns:

the number of digital outs as int.

getDigitalInRange

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

Description copied from interface: ProcessImage

Returns a range of DigitalIn instances.

Specified by:

getDigitalInRange in interface ProcessImage

Parameters:

ref - the start offset.

count - the amount of DigitalIn from the offset.

Returns:

an array of DigitalIn instances.

getDigitalIn

public DigitalIn getDigitalIn(int ref)
                       throws IllegalAddressException

Description copied from interface: ProcessImage

Returns the DigitalIn instance at the given reference.

Specified by:

getDigitalIn in interface ProcessImage

Parameters:

ref - the reference.

Returns:

the DigitalIn instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getDigitalInCount

public int getDigitalInCount()

Description copied from interface: ProcessImage

Returns the number of DigitalIn instances in this ProcessImage.

Specified by:

getDigitalInCount in interface ProcessImage

Returns:

the number of digital ins as int.

getInputRegisterRange

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

Description copied from interface: ProcessImage

Returns a range of InputRegister instances.

Specified by:

getInputRegisterRange in interface ProcessImage

Parameters:

ref - the start offset.

count - the amount of InputRegister from the offset.

Returns:

an array of InputRegister instances.

getInputRegister

public InputRegister getInputRegister(int ref)
                               throws IllegalAddressException

Description copied from interface: ProcessImage

Returns the InputRegister instance at the given reference.

Specified by:

getInputRegister in interface ProcessImage

Parameters:

ref - the reference.

Returns:

the InputRegister instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getInputRegisterCount

public int getInputRegisterCount()

Description copied from interface: ProcessImage

Returns the number of InputRegister instances in this ProcessImage.

This is not the same as the value of the highest addressable register.

Specified by:

getInputRegisterCount in interface ProcessImage

Returns:

the number of input registers as int.

getRegisterRange

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

Description copied from interface: ProcessImage

Returns a range of Register instances.

Specified by:

getRegisterRange in interface ProcessImage

Parameters:

ref - the start offset.

count - the amount of Register from the offset.

Returns:

an array of Register instances.

getRegister

public Register getRegister(int ref)
                     throws IllegalAddressException

Description copied from interface: ProcessImage

Returns the Register instance at the given reference.

Specified by:

getRegister in interface ProcessImage

Parameters:

ref - the reference.

Returns:

the Register instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getRegisterCount

public int getRegisterCount()

Description copied from interface: ProcessImage

Returns the number of Register instances in this ProcessImage.

This is not the same as the value of the highest addressable register.

Specified by:

getRegisterCount in interface ProcessImage

Returns:

the number of registers as int.

getFile

public File getFile(int fileNumber)

Description copied from interface: ProcessImage

Returns the File instance at the given reference.

Specified by:

getFile in interface ProcessImage

Parameters:

fileNumber - the reference.

Returns:

the File instance at the given address.

getFileByNumber

public File getFileByNumber(int ref)

Description copied from interface: ProcessImage

Returns the File instance having the specified file number.

Specified by:

getFileByNumber in interface ProcessImage

Parameters:

ref - The file number for the File object to be returned.

Returns:

the File instance having the given number.

getFileCount

public int getFileCount()

Description copied from interface: ProcessImage

Returns the number of File instances in this ProcessImage.

This is not the same as the value of the highest addressable register.

Specified by:

getFileCount in interface ProcessImage

Returns:

the number of registers as int.

getFIFO

public FIFO getFIFO(int fifoNumber)

Description copied from interface: ProcessImage

Returns the FIFO instance in the list of all FIFO objects in this ProcessImage.

Specified by:

getFIFO in interface ProcessImage

Parameters:

fifoNumber - the reference.

Returns:

the File instance at the given address.

getFIFOByAddress

public FIFO getFIFOByAddress(int ref)

Description copied from interface: ProcessImage

Returns the FIFO instance having the specified base address.

Specified by:

getFIFOByAddress in interface ProcessImage

Parameters:

ref - The address for the FIFO object to be returned.

Returns:

the FIFO instance having the given base address

getFIFOCount

public int getFIFOCount()

Description copied from interface: ProcessImage

Returns the number of File instances in this ProcessImage.

This is not the same as the value of the highest addressable register.

Specified by:

getFIFOCount in interface ProcessImage

Returns:

the number of registers as int.

setDigitalOut

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

Description copied from interface: ProcessImageImplementation

Sets a new DigitalOut instance at the given reference.

Specified by:

setDigitalOut in interface ProcessImageImplementation

Parameters:

ref - the reference as int.

out - the new DigitalOut instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addDigitalOut

public void addDigitalOut(DigitalOut out)

Description copied from interface: ProcessImageImplementation

Adds a new DigitalOut instance.

Specified by:

addDigitalOut in interface ProcessImageImplementation

Parameters:

out - the DigitalOut instance to be added.

addDigitalOut

public void addDigitalOut(int ref,
                          DigitalOut dout)

Description copied from interface: ProcessImageImplementation

Adds a new DigitalOut instance at the given reference.

Specified by:

addDigitalOut in interface ProcessImageImplementation

Parameters:

ref - - the reference for the instance.

dout - - the DigitalOut instance to be added.

removeDigitalOut

public void removeDigitalOut(DigitalOut out)

Description copied from interface: ProcessImageImplementation

Removes a given DigitalOut instance.

Specified by:

removeDigitalOut in interface ProcessImageImplementation

Parameters:

out - the DigitalOut instance to be removed.

setDigitalIn

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

Description copied from interface: ProcessImageImplementation

Sets a new DigitalIn instance at the given reference.

Specified by:

setDigitalIn in interface ProcessImageImplementation

Parameters:

ref - the reference as int.

di - the new DigitalIn instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addDigitalIn

public void addDigitalIn(DigitalIn di)

Description copied from interface: ProcessImageImplementation

Adds a new DigitalIn instance.

Specified by:

addDigitalIn in interface ProcessImageImplementation

Parameters:

di - the DigitalIn instance to be added.

addDigitalIn

public void addDigitalIn(int ref,
                         DigitalIn d1)

Description copied from interface: ProcessImageImplementation

Adds a new DigitalIn instance at the given reference, possibly creating a hole between the last existing reference and the new object.

Specified by:

addDigitalIn in interface ProcessImageImplementation

Parameters:

ref - - the reference for the new instance.

d1 - the DigitalIn instance to be added.

removeDigitalIn

public void removeDigitalIn(DigitalIn di)

Description copied from interface: ProcessImageImplementation

Removes a given DigitalIn instance.

Specified by:

removeDigitalIn in interface ProcessImageImplementation

Parameters:

di - the DigitalIn instance to be removed.

setInputRegister

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

Description copied from interface: ProcessImageImplementation

Sets a new InputRegister instance at the given reference.

Specified by:

setInputRegister in interface ProcessImageImplementation

Parameters:

ref - the reference as int.

reg - the new InputRegister instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addInputRegister

public void addInputRegister(InputRegister reg)

Description copied from interface: ProcessImageImplementation

Adds a new InputRegister instance.

Specified by:

addInputRegister in interface ProcessImageImplementation

Parameters:

reg - the InputRegister instance to be added.

addInputRegister

public void addInputRegister(int ref,
                             InputRegister inReg)

Description copied from interface: ProcessImageImplementation

Adds a new InputRegister instance, possibly creating a hole between the last existing reference and the new object.

Specified by:

addInputRegister in interface ProcessImageImplementation

Parameters:

ref - - The reference for the new instance.

inReg - the InputRegister instance to be added.

removeInputRegister

public void removeInputRegister(InputRegister reg)

Description copied from interface: ProcessImageImplementation

Removes a given InputRegister instance.

Specified by:

removeInputRegister in interface ProcessImageImplementation

Parameters:

reg - the InputRegister instance to be removed.

setRegister

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

Description copied from interface: ProcessImageImplementation

Sets a new Register instance at the given reference.

Specified by:

setRegister in interface ProcessImageImplementation

Parameters:

ref - the reference as int.

reg - the new Register instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addRegister

public void addRegister(Register reg)

Description copied from interface: ProcessImageImplementation

Adds a new Register instance.

Specified by:

addRegister in interface ProcessImageImplementation

Parameters:

reg - the Register instance to be added.

addRegister

public void addRegister(int ref,
                        Register reg)

Description copied from interface: ProcessImageImplementation

Adds a new Register instance, possibly creating a hole between the last existing reference and the new object.

Specified by:

addRegister in interface ProcessImageImplementation

Parameters:

ref - - the reference for the new instance.

reg - the Register instance to be added.

removeRegister

public void removeRegister(Register reg)

Description copied from interface: ProcessImageImplementation

Removes a given Register instance.

Specified by:

removeRegister in interface ProcessImageImplementation

Parameters:

reg - the Register instance to be removed.

setFile

public void setFile(int fileNumber,
                    File file)

Description copied from interface: ProcessImageImplementation

Sets a new File instance at the given reference.

Specified by:

setFile in interface ProcessImageImplementation

Parameters:

fileNumber - the reference as int.

file - the new File instance to be set.

addFile

public void addFile(File newFile)

Description copied from interface: ProcessImageImplementation

Adds a new File instance.

Specified by:

addFile in interface ProcessImageImplementation

Parameters:

newFile - the File instance to be added.

addFile

public void addFile(int ref,
                    File newFile)

Description copied from interface: ProcessImageImplementation

Adds a new File instance, possibly creating a hole between the last existing reference and the new object.

Specified by:

addFile in interface ProcessImageImplementation

Parameters:

ref - - the reference for the new isntance.

newFile - the File instance to be added.

removeFile

public void removeFile(File oldFile)

Description copied from interface: ProcessImageImplementation

Removes a given File instance.

Specified by:

removeFile in interface ProcessImageImplementation

Parameters:

oldFile - the File instance to be removed.

setFIFO

public void setFIFO(int fifoNumber,
                    FIFO fifo)

Description copied from interface: ProcessImageImplementation

Sets a new FIFO instance at the given reference.

Specified by:

setFIFO in interface ProcessImageImplementation

Parameters:

fifoNumber - the reference as int.

fifo - the new FIFO instance to be set.

addFIFO

public void addFIFO(FIFO fifo)

Description copied from interface: ProcessImageImplementation

Adds a new FIFO instance.

Specified by:

addFIFO in interface ProcessImageImplementation

Parameters:

fifo - the FIFO instance to be added.

addFIFO

public void addFIFO(int ref,
                    FIFO newFIFO)

Description copied from interface: ProcessImageImplementation

Adds a new FIFO instance, possibly creating a hole between the last existing reference and the new object.

Specified by:

addFIFO in interface ProcessImageImplementation

Parameters:

ref - - the reference for the new instance.

newFIFO - the FIFO instance to be added.

removeFIFO

public void removeFIFO(FIFO oldFIFO)

Description copied from interface: ProcessImageImplementation

Removes a given FIFO instance.

Specified by:

removeFIFO in interface ProcessImageImplementation

Parameters:

oldFIFO - the FIFO instance to be removed.