Io.java

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <Io.java>
// -----------------------------------------------------------------------
// Copyright (c) 2012 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the Names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
package com.boschrexroth.mlpi;


public class Io extends MlpiComponent {
  /*
   * Enums
   */
  public enum IoFieldbusMasterType
  {
    FIELDBUS_MASTER_GENERIC         (0),
    FIELDBUS_MASTER_ONBOARD_IO      (1),
    FIELDBUS_MASTER_INLINE_IO       (2),
    FIELDBUS_MASTER_PROFIBUS_DP     (3),
    FIELDBUS_MASTER_SERCOS_III      (4),
    FIELDBUS_MASTER_FAST_IO         (5),
    FIELDBUS_MASTER_PROFINET        (6),
    FIELDBUS_MASTER_DEVICENET       (7),
    FIELDBUS_MASTER_ETHERNET_IP     (8),
    FIELDBUS_MASTER_ETHERNET_NETX   (9);

    private int _code;
    int getCode() { return _code; }
    IoFieldbusMasterType(int code) { this._code = code; }
    static IoFieldbusMasterType valueOf(int code) {
      for (IoFieldbusMasterType value : values()) {
        if (code == value.getCode()) return value;
      }
      return null;
    }
  };

  public enum IoFieldbusArea
  {
    IO_AREA_INPUT  (0),
    IO_AREA_OUTPUT  (1);

    private int _code;
    int getCode() { return _code; }
    IoFieldbusArea(int code) { this._code = code; }
    static IoFieldbusArea valueOf(int code) {
      for (IoFieldbusArea value : values()) {
        if (code == value.getCode()) return value;
      }
      return null;
    }
  }

  /*
   * Structs
   */
  public static class IoHandle
  {
    public int ident;
    public int hash;
  }

  public static class IoDiagnosis
  {
    public int flags;
  }

  public static class  IoFieldbusSlaveInfo
  {
    public IoHandle     handle = new IoHandle();
    public String       name;
    public IoDiagnosis  diagnosis = new IoDiagnosis();
    public String       address;
    public int          numberOfInputs;
    public int          numberOfOutputs;
  }

  public static class  IoFieldbusMasterInfo
  {
    public IoHandle              handle = new IoHandle();
    public String                name;
    public IoDiagnosis           diagnosis = new IoDiagnosis();
    public IoFieldbusMasterType  type;
    public int                   numberOfSlaves;
  }

  /*
   * Methods
   */
  Io(MlpiHandle connection) {
    super(connection);
  }
  
  public Fieldbus fieldbusses(String name) {
    return new Fieldbus(getConnectionHandleObject(), name);
  }
  
  public native String[] readFieldbusMasterList();
}