Container.java

Go to the documentation of this file.

// -----------------------------------------------------------------------
// MLPI - <System.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;

import java.util.HashMap;
import java.util.Map;
import java.util.Vector;

import com.boschrexroth.mlpi.MlpiComponent.MlpiHandle;
import com.boschrexroth.mlpi.MlpiGlobal.DateAndTime;
import com.boschrexroth.mlpi.Motion.AxisRef;
import com.boschrexroth.mlpi.Motion.ProfileStartPoint;

public class Container extends MlpiComponent {
  /*
   * Constants
   */
  public final String CONTAINER_TAG_SEPARATOR                     = ";";
  public final String CONTAINER_ARG_SEPARATOR                     = ",";

  public final String CONTAINER_TAG_LOGICLIB_MEMORY_AREA          = "LOGICLIB_MEMORY_AREA";
  public final String CONTAINER_TAG_LOGICLIB_SYMBOL               = "LOGICLIB_SYMBOL";
  public final String CONTAINER_TAG_IOLIB_FIELBUS_IO              = "IOLIB_FIELBUS_IO"; //<! Deprecated.
  public final String CONTAINER_TAG_IOLIB_FIELDBUS_IO             = "IOLIB_FIELBUS_IO"; //<! Spelling of "Fieldbus" was wrong till MLPI version 1.5.0.0. Due to compatibility reasons, we can not change the adapted string value.
  public final String CONTAINER_TAG_ALIGNMENT_DUMMY               = "ALIGNMENT_DUMMY";

  public final String CONTAINER_ARG_IOLIB_IO_AREA_INPUT           = "INPUT";
  public final String CONTAINER_ARG_IOLIB_IO_AREA_OUTPUT          = "OUTPUT";

  public final String CONTAINER_ARG_LOGICLIB_MEMORY_AREA_INPUT    = "INPUT";
  public final String CONTAINER_ARG_LOGICLIB_MEMORY_AREA_OUTPUT   = "OUTPUT";
  public final String CONTAINER_ARG_LOGICLIB_MEMORY_AREA_MARKER   = "MARKER";

  
  /*
   * Enums
   */
  public enum ContainerAccess
  {
    CONTAINER_ACCESS_READ     (0),
    CONTAINER_ACCESS_WRITE    (1);

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

  
  public static class ContainerInformation
  {
    String              name;                         
    DateAndTime         dateTime = new DateAndTime(); 
    int                 numItems;                     
    int                 numElementsTagList;           
    int                 dataSize;                     
    ContainerAccess     accessFlag;                   
  };
  
  public static class ContainerItemInformation
  {
    MlpiGlobal.Type     type;                         
    int                 offset;                       
    int                 dataSize;                     
    
    public MlpiGlobal.Type getType() {return type;}
    public int getOffset()           {return offset;}
    public int getDataSize()         {return dataSize;}
  };
  
  public static class ContainerHandle
  {
    public ContainerHandle() {
      connectionID = -1;
      containerID = -1;
    }
    int                 connectionID;                 
    int                 containerID;                  
  };
  
  
  /*
   * Fields
   */
  Map<String, ContainerStructure> _readContainers = new HashMap<String, ContainerStructure>();
  Map<String, ContainerStructure> _writeContainers = new HashMap<String, ContainerStructure>();

  
  /*
   * Methods
   */
  Container(MlpiHandle connection) {
    super(connection);
  }

  
  public synchronized ContainerStructure read(String name) {
    ContainerStructure container = _readContainers.get(name);
    
    if (container == null) {
      container = new ContainerStructure(this, name, ContainerAccess.CONTAINER_ACCESS_READ);
      _readContainers.put(name, container);
    }
    return container;
  }
  
  public synchronized ContainerStructure write(String name) {
    ContainerStructure container = _writeContainers.get(name);
    
    if (container == null) {
      container = new ContainerStructure(this, name, ContainerAccess.CONTAINER_ACCESS_WRITE);
      _writeContainers.put(name, container);
    }
    return container;
  }
  
  public native int                         create(String tagList, ContainerAccess accessFlag, ContainerHandle containerHandle);
  
  public native byte[]                      update(ContainerHandle containerHandle, byte[] buffer);
  
  public native void                        destroy(ContainerHandle containerHandle);
  
  public native void                        setName(ContainerHandle containerHandle, String name);
  
  public native String                      getName(ContainerHandle containerHandle);
  
  public native ContainerInformation        getInformation(ContainerHandle containerHandle);
  
  public native String[]                    getTagList(ContainerHandle containerHandle);
  
  public native ContainerItemInformation[]  getItemInformation(ContainerHandle containerHandle);
}