net.wimpi.modbus.procimg
Interface ProcessImage

All Known Subinterfaces:

ProcessImageImplementation

All Known Implementing Classes:

SimpleProcessImage

public interface ProcessImage

Interface defining a process image in an object oriented manner.

The process image is understood as a shared memory area used form communication between slave and master or device side.

Version:

@version@ (@date@)

Author:

Dieter Wimberger

Method Summary

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 offset, 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 offset, int count) Returns a range of DigitalOut instances.
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 offset, 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 offset, int count) Returns a range of Register instances.

Method Detail

getDigitalOutRange

DigitalOut[] getDigitalOutRange(int offset,
                                int count)
                                throws IllegalAddressException

Returns a range of DigitalOut instances.

Parameters:

offset - the start offset.

count - the amount of DigitalOut from the offset.

Returns:

an array of DigitalOut instances.

Throws:

IllegalAddressException - if the range from offset to offset+count is non existant.

getDigitalOut

DigitalOut getDigitalOut(int ref)
                         throws IllegalAddressException

Returns the DigitalOut instance at the given reference.

Parameters:

ref - the reference.

Returns:

the DigitalOut instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getDigitalOutCount

int getDigitalOutCount()

Returns the number of DigitalOut instances in this ProcessImage.

Returns:

the number of digital outs as int.

getDigitalInRange

DigitalIn[] getDigitalInRange(int offset,
                              int count)
                              throws IllegalAddressException

Returns a range of DigitalIn instances.

Parameters:

offset - the start offset.

count - the amount of DigitalIn from the offset.

Returns:

an array of DigitalIn instances.

Throws:

IllegalAddressException - if the range from offset to offset+count is non existant.

getDigitalIn

DigitalIn getDigitalIn(int ref)
                       throws IllegalAddressException

Returns the DigitalIn instance at the given reference.

Parameters:

ref - the reference.

Returns:

the DigitalIn instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getDigitalInCount

int getDigitalInCount()

Returns the number of DigitalIn instances in this ProcessImage.

Returns:

the number of digital ins as int.

getInputRegisterRange

InputRegister[] getInputRegisterRange(int offset,
                                      int count)
                                      throws IllegalAddressException

Returns a range of InputRegister instances.

Parameters:

offset - the start offset.

count - the amount of InputRegister from the offset.

Returns:

an array of InputRegister instances.

Throws:

IllegalAddressException - if the range from offset to offset+count is non existant.

getInputRegister

InputRegister getInputRegister(int ref)
                               throws IllegalAddressException

Returns the InputRegister instance at the given reference.

Parameters:

ref - the reference.

Returns:

the InputRegister instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getInputRegisterCount

int getInputRegisterCount()

Returns the number of InputRegister instances in this ProcessImage.

Returns:

the number of input registers as int.

getRegisterRange

Register[] getRegisterRange(int offset,
                            int count)
                            throws IllegalAddressException

Returns a range of Register instances.

Parameters:

offset - the start offset.

count - the amount of Register from the offset.

Returns:

an array of Register instances.

Throws:

IllegalAddressException - if the range from offset to offset+count is non existant.

getRegister

Register getRegister(int ref)
                     throws IllegalAddressException

Returns the Register instance at the given reference.

Parameters:

ref - the reference.

Returns:

the Register instance at the given address.

Throws:

IllegalAddressException - if the reference is invalid.

getRegisterCount

int getRegisterCount()

Returns the number of Register instances in this ProcessImage.

Returns:

the number of registers as int.