com.ghgande.j2mod.modbus.procimg

Interface ProcessImageImplementation

All Superinterfaces:

ProcessImage

All Known Implementing Classes:

SimpleProcessImage

public interface ProcessImageImplementation
extends ProcessImage

Interface defining implementation specific details of the ProcessImage, adding mechanisms for creating and modifying the actual "process image".

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Field Summary

Fields

Modifier and Type	Field and Description
static byte	DIG_FALSE Defines the unset state (i.e.
static byte	DIG_INVALID Defines the invalid (unset, neither true nor false) state of a digital input or output.
static byte	DIG_TRUE Defines the set state (i.e.

Method Summary

Modifier and Type	Method and Description
void	addDigitalIn(DigitalIn di) Adds a new DigitalIn instance.
void	addDigitalIn(int ref, DigitalIn di) 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 out) Adds a new DigitalOut instance at the given reference.
void	addFIFO(FIFO reg) Adds a new FIFO instance.
void	addFIFO(int ref, FIFO reg) Adds a new FIFO instance, possibly creating a hole between the last existing reference and the new object.
void	addFile(File reg) Adds a new File instance.
void	addFile(int ref, File reg) 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 reg) 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.
void	removeDigitalIn(DigitalIn di) Removes a given DigitalIn instance.
void	removeDigitalOut(DigitalOut out) Removes a given DigitalOut instance.
void	removeFIFO(FIFO reg) Removes a given FIFO instance.
void	removeFile(File reg) 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 ref, FIFO reg) Sets a new FIFO instance at the given reference.
void	setFile(int ref, File reg) Sets a new File instance at the given reference.
void	setInputRegister(int ref, InputRegister reg) Sets a new InputRegister instance at the given reference.
void	setRegister(int ref, Register reg) Sets a new Register instance at the given reference.

Methods inherited from interface com.ghgande.j2mod.modbus.procimg.ProcessImage

getDigitalIn, getDigitalInCount, getDigitalInRange, getDigitalOut, getDigitalOutCount, getDigitalOutRange, getFIFO, getFIFOByAddress, getFIFOCount, getFile, getFileByNumber, getFileCount, getInputRegister, getInputRegisterCount, getInputRegisterRange, getRegister, getRegisterCount, getRegisterRange

Field Detail

DIG_TRUE

static final byte DIG_TRUE

Defines the set state (i.e. true) of a digital input or output.

See Also:

Constant Field Values

DIG_FALSE

static final byte DIG_FALSE

Defines the unset state (i.e. false) of a digital input or output.

See Also:

Constant Field Values

DIG_INVALID

static final byte DIG_INVALID

Defines the invalid (unset, neither true nor false) state of a digital input or output.

See Also:

Constant Field Values

Method Detail

setDigitalOut

void setDigitalOut(int ref,
                   DigitalOut out)
            throws IllegalAddressException

Sets a new DigitalOut instance at the given reference.

Parameters:

ref - the reference as int.

out - the new DigitalOut instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addDigitalOut

void addDigitalOut(DigitalOut out)

Adds a new DigitalOut instance.

Parameters:

out - the DigitalOut instance to be added.

addDigitalOut

void addDigitalOut(int ref,
                   DigitalOut out)

Adds a new DigitalOut instance at the given reference.

Parameters:

ref - - the reference for the instance.

out - - the DigitalOut instance to be added.

removeDigitalOut

void removeDigitalOut(DigitalOut out)

Removes a given DigitalOut instance.

Parameters:

out - the DigitalOut instance to be removed.

setDigitalIn

void setDigitalIn(int ref,
                  DigitalIn di)
           throws IllegalAddressException

Sets a new DigitalIn instance at the given reference.

Parameters:

ref - the reference as int.

di - the new DigitalIn instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addDigitalIn

void addDigitalIn(DigitalIn di)

Adds a new DigitalIn instance.

Parameters:

di - the DigitalIn instance to be added.

addDigitalIn

void addDigitalIn(int ref,
                  DigitalIn di)

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

Parameters:

ref - - the reference for the new instance.

di - the DigitalIn instance to be added.

removeDigitalIn

void removeDigitalIn(DigitalIn di)

Removes a given DigitalIn instance.

Parameters:

di - the DigitalIn instance to be removed.

setInputRegister

void setInputRegister(int ref,
                      InputRegister reg)
               throws IllegalAddressException

Sets a new InputRegister instance at the given reference.

Parameters:

ref - the reference as int.

reg - the new InputRegister instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addInputRegister

void addInputRegister(InputRegister reg)

Adds a new InputRegister instance.

Parameters:

reg - the InputRegister instance to be added.

addInputRegister

void addInputRegister(int ref,
                      InputRegister reg)

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

Parameters:

ref - - The reference for the new instance.

reg - the InputRegister instance to be added.

removeInputRegister

void removeInputRegister(InputRegister reg)

Removes a given InputRegister instance.

Parameters:

reg - the InputRegister instance to be removed.

setRegister

void setRegister(int ref,
                 Register reg)
          throws IllegalAddressException

Sets a new Register instance at the given reference.

Parameters:

ref - the reference as int.

reg - the new Register instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addRegister

void addRegister(Register reg)

Adds a new Register instance.

Parameters:

reg - the Register instance to be added.

addRegister

void addRegister(int ref,
                 Register reg)

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

Parameters:

ref - - the reference for the new instance.

reg - the Register instance to be added.

removeRegister

void removeRegister(Register reg)

Removes a given Register instance.

Parameters:

reg - the Register instance to be removed.

setFile

void setFile(int ref,
             File reg)
      throws IllegalAddressException

Sets a new File instance at the given reference.

Parameters:

ref - the reference as int.

reg - the new File instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addFile

void addFile(File reg)

Adds a new File instance.

Parameters:

reg - the File instance to be added.

addFile

void addFile(int ref,
             File reg)

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

Parameters:

ref - - the reference for the new isntance.

reg - the File instance to be added.

removeFile

void removeFile(File reg)

Removes a given File instance.

Parameters:

reg - the File instance to be removed.

setFIFO

void setFIFO(int ref,
             FIFO reg)
      throws IllegalAddressException

Sets a new FIFO instance at the given reference.

Parameters:

ref - the reference as int.

reg - the new FIFO instance to be set.

Throws:

IllegalAddressException - if the reference is invalid.

addFIFO

void addFIFO(FIFO reg)

Adds a new FIFO instance.

Parameters:

reg - the FIFO instance to be added.

addFIFO

void addFIFO(int ref,
             FIFO reg)

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

Parameters:

ref - - the reference for the new instance.

reg - the FIFO instance to be added.

removeFIFO

void removeFIFO(FIFO reg)

Removes a given FIFO instance.

Parameters:

reg - the FIFO instance to be removed.