jamod at SF

net.wimpi.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:
1.2rc1 (09/11/2004)
Author:
Dieter Wimberger

Field Summary
static byte DIG_FALSE
          Defines the unset state (i.e.
static byte DIG_INVALID
          Defines the invalid state of a digital input or output.
static byte DIG_TRUE
          Defines the set state (i.e.
 
Method Summary
 void addDigitalIn(DigitalIn di)
          Adds a new DigitalIn instance.
 void addDigitalOut(DigitalOut _do)
          Adds a new DigitalOut instance.
 void addInputRegister(InputRegister reg)
          Adds a new InputRegister instance.
 void addRegister(Register reg)
          Adds a new Register instance.
 void removeDigitalIn(DigitalIn di)
          Removes a given DigitalIn instance.
 void removeDigitalOut(DigitalOut _do)
          Removes a given DigitalOut 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 _do)
          Sets a new DigitalOut 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 net.wimpi.modbus.procimg.ProcessImage
getDigitalIn, getDigitalInCount, getDigitalInRange, getDigitalOut, getDigitalOutCount, getDigitalOutRange, getInputRegister, getInputRegisterCount, getInputRegisterRange, getRegister, getRegisterCount, getRegisterRange
 

Field Detail

DIG_TRUE

public 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

public 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

public static final byte DIG_INVALID
Defines the invalid state of a digital input or output.

See Also:
Constant Field Values
Method Detail

setDigitalOut

public void setDigitalOut(int ref,
                          DigitalOut _do)
                   throws IllegalAddressException
Sets a new DigitalOut instance at the given reference.

Parameters:
ref - the reference as int.
_do - the new DigitalOut instance to be set.
Throws:
IllegalAddressException - if the reference is invalid.

addDigitalOut

public void addDigitalOut(DigitalOut _do)
Adds a new DigitalOut instance.

Parameters:
_do - the DigitalOut instance to be added.

removeDigitalOut

public void removeDigitalOut(DigitalOut _do)
Removes a given DigitalOut instance.

Parameters:
_do - the DigitalOut instance to be removed.

setDigitalIn

public 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

public void addDigitalIn(DigitalIn di)
Adds a new DigitalIn instance.

Parameters:
di - the DigitalIn instance to be added.

removeDigitalIn

public void removeDigitalIn(DigitalIn di)
Removes a given DigitalIn instance.

Parameters:
di - the DigitalIn instance to be removed.

setInputRegister

public 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

public void addInputRegister(InputRegister reg)
Adds a new InputRegister instance.

Parameters:
reg - the InputRegister instance to be added.

removeInputRegister

public void removeInputRegister(InputRegister reg)
Removes a given InputRegister instance.

Parameters:
reg - the InputRegister instance to be removed.

setRegister

public 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

public void addRegister(Register reg)
Adds a new Register instance.

Parameters:
reg - the Register instance to be added.

removeRegister

public void removeRegister(Register reg)
Removes a given Register instance.

Parameters:
reg - the Register instance to be removed.

jamod at SF

Copyright © 2002-2004 jamod development team.