net.wimpi.modbus.procimg.ProcessImageImplementation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jamod Show documentation
jamod is an object oriented implementation of the Modbus protocol, realized 100% in Java. It allows to quickly realize master and slave applications in various transport flavors (IP and serial).
The newest version!
/***
 * Copyright 2002-2010 jamod development team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ***/

package net.wimpi.modbus.procimg;

/**
 * Interface defining implementation specific
 * details of the ProcessImage, adding
 * mechanisms for creating and modifying the actual
 * "process image".
 *
 * @author Dieter Wimberger
 * @version 1.2 (@date@)
 */
public interface ProcessImageImplementation extends ProcessImage {

  /**
   * Sets a new DigitalOut instance at the
   * given reference.
   *
   * @param ref the reference as int.
   * @param _do the new DigitalOut instance to be
   *        set.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public void setDigitalOut(int ref, DigitalOut _do)
      throws IllegalAddressException;

  /**
   * Adds a new DigitalOut instance.
   *
   * @param _do the DigitalOut instance to be
   *        added.
   */
  public void addDigitalOut(DigitalOut _do);

  /**
   * Removes a given DigitalOut instance.
   *
   * @param _do the DigitalOut instance to be
   *        removed.
   */
  public void removeDigitalOut(DigitalOut _do);

  /**
   * Sets a new DigitalIn instance at the
   * given reference.
   *
   * @param ref the reference as int.
   * @param di the new DigitalIn instance to be
   *        set.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public void setDigitalIn(int ref, DigitalIn di)
      throws IllegalAddressException;

  /**
   * Adds a new DigitalIn instance.
   *
   * @param di the DigitalIn instance to be
   *        added.
   */
  public void addDigitalIn(DigitalIn di);

  /**
   * Removes a given DigitalIn instance.
   *
   * @param di the DigitalIn instance to be
   *        removed.
   */
  public void removeDigitalIn(DigitalIn di);

  /**
   * Sets a new InputRegister instance at the
   * given reference.
   *
   * @param ref the reference as int.
   * @param reg the new InputRegister instance to be
   *        set.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public void setInputRegister(int ref, InputRegister reg)
      throws IllegalAddressException;

  /**
   * Adds a new InputRegister instance.
   *
   * @param reg the InputRegister instance to be
   *        added.
   */
  public void addInputRegister(InputRegister reg);

  /**
   * Removes a given InputRegister instance.
   *
   * @param reg the InputRegister instance to be
   *        removed.
   */
  public void removeInputRegister(InputRegister reg);

  /**
   * Sets a new Register instance at the
   * given reference.
   *
   * @param ref the reference as int.
   * @param reg the new Register instance to be
   *        set.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public void setRegister(int ref, Register reg)
      throws IllegalAddressException;

  /**
   * Adds a new Register instance.
   *
   * @param reg the Register instance to be
   *        added.
   */
  public void addRegister(Register reg);

  /**
   * Removes a given Register instance.
   *
   * @param reg the Register instance to be
   *        removed.
   */
  public void removeRegister(Register reg);

  /**
   * Defines the set state (i.e. true) of
   * a digital input or output.
   */
  public static final byte DIG_TRUE = 1;

  /**
   * Defines the unset state (i.e. false) of
   * a digital input or output.
   */
  public static final byte DIG_FALSE = 0;

  /**
   * Defines the invalid state of
   * a digital input or output.
   */
  public static final byte DIG_INVALID = -1;

}//ProcessImageImplementation