net.wimpi.modbus.procimg.ProcessImage 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 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.
 *
 * @author Dieter Wimberger
 * @version 1.2 (@date@)
 */
public interface ProcessImage {

  /**
   * Returns a range of DigitalOut instances.
   * 

   *
   * @param offset the start offset.
   * @param count the amount of DigitalOut from the offset.
   *
   * @return an array of DigitalOut instances.
   *
   * @throws IllegalAddressException if the range from offset
   *         to offset+count is non existant.
   */
  public DigitalOut[] getDigitalOutRange(int offset, int count)
      throws IllegalAddressException;

  /**
   * Returns the DigitalOut instance at the given
   * reference.
   * 

   *
   * @param ref the reference.
   *
   * @return the DigitalOut instance at the given address.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public DigitalOut getDigitalOut(int ref)
      throws IllegalAddressException;

  /**
   * Returns the number of DigitalOut instances
   * in this ProcessImage.
   *
   * @return the number of digital outs as int.
   */
  public int getDigitalOutCount();

  /**
   * Returns a range of DigitalIn instances.
   * 

   *
   * @param offset the start offset.
   * @param count the amount of DigitalIn from the offset.
   *
   * @return an array of DigitalIn instances.
   *
   * @throws IllegalAddressException if the range from offset
   *         to offset+count is non existant.
   */
  public DigitalIn[] getDigitalInRange(int offset, int count)
      throws IllegalAddressException;

  /**
   * Returns the DigitalIn instance at the given
   * reference.
   * 

   *
   * @param ref the reference.
   *
   * @return the DigitalIn instance at the given address.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public DigitalIn getDigitalIn(int ref)
      throws IllegalAddressException;

  /**
   * Returns the number of DigitalIn instances
   * in this ProcessImage.
   *
   * @return the number of digital ins as int.
   */
  public int getDigitalInCount();

  /**
   * Returns a range of InputRegister instances.
   * 

   *
   * @param offset the start offset.
   * @param count the amount of InputRegister
   *        from the offset.
   *
   * @return an array of InputRegister instances.
   *
   * @throws IllegalAddressException if the range from offset
   *         to offset+count is non existant.
   */
  public InputRegister[] getInputRegisterRange(int offset, int count)
      throws IllegalAddressException;

  /**
   * Returns the InputRegister instance at the given
   * reference.
   * 

   *
   * @param ref the reference.
   *
   * @return the InputRegister instance at the given address.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public InputRegister getInputRegister(int ref)
      throws IllegalAddressException;


  /**
   * Returns the number of InputRegister instances
   * in this ProcessImage.
   *
   * @return the number of input registers as int.
   */
  public int getInputRegisterCount();

  /**
   * Returns a range of Register instances.
   * 

   *
   * @param offset the start offset.
   * @param count the amount of Register from the offset.
   *
   * @return an array of Register instances.
   *
   * @throws IllegalAddressException if the range from offset
   *         to offset+count is non existant.
   */
  public Register[] getRegisterRange(int offset, int count)
      throws IllegalAddressException;

  /**
   * Returns the Register instance at the given
   * reference.
   * 
   *
   * @param ref the reference.
   *
   * @return the Register instance at the given address.
   *
   * @throws IllegalAddressException if the reference is invalid.
   */
  public Register getRegister(int ref)
      throws IllegalAddressException;

  /**
   * Returns the number of Register instances
   * in this ProcessImage.
   *
   * @return the number of registers as int.
   */
  public int getRegisterCount();

}//interface ProcessImage