fr.esrf.TangoApi.PipeDataElement Maven / Gradle / Ivy

Go to download
//+======================================================================
// $Source$
//
// Project:   Tango
//
// Description:  java source code for the TANGO client/server API.
//
// $Author: pascal_verdier $
//
// Copyright (C) :      2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,
//						European Synchrotron Radiation Facility
//                      BP 220, Grenoble 38043
//                      FRANCE
//
// This file is part of Tango.
//
// Tango is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Tango is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Tango.  If not, see .
//
// $Revision: 25296 $
//
//-======================================================================
package fr.esrf.TangoApi;

import fr.esrf.Tango.*;
import fr.esrf.TangoDs.Except;
import fr.esrf.TangoDs.TangoConst;
import fr.esrf.utils.ArrayUtils;

import java.lang.reflect.Array;


/**
 * This class defined an elementary element of a pipe blob.
 */

public class  PipeDataElement{
    private DevPipeDataElt element;
    private static final String SCALAR = "Scalar";
    private static final String ARRAY  = "Array";
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param element  data element IDL object
     */
    // ===================================================================
    public PipeDataElement(DevPipeDataElt element) {
        this.element = element;
    }
    // ===================================================================
    /**
     * Create the PipeDataElement 
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, boolean value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.bool_att_value(new boolean[]{value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, boolean[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.bool_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, short value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.short_att_value(new short[]{value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, short[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.short_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     * @param asUChar  insert data as unsigned char if true as short if false
     */
    // ===================================================================
    public PipeDataElement(String name, short[] value, boolean asUChar) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        if (asUChar) {
            final byte[] unsigned = new byte[value.length];
            for (int i = 0; i < value.length; i++) {
                unsigned[i] = (byte) (value[i] & 0xFF);
            }
            attrValUnion.uchar_att_value(unsigned); //  as unsigned char
        }
        else
            attrValUnion.short_att_value(value); // as short
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, int value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.long_att_value(new int[] {value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, int[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.long_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     * @param asUShort  insert data as unsigned short if true as int (DevLong) if false
     */
    // ===================================================================
    public PipeDataElement(String name, int[] value, boolean asUShort) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        if (asUShort) {
            final short[] unsigned = new short[value.length];
            for (int i = 0; i < value.length; i++) {
                unsigned[i] = (short) (value[i] & 0xFFFF);
            }
            attrValUnion.ushort_att_value(unsigned); //  as unsigned short
        }
        else
            attrValUnion.long_att_value(value); // as DevLong
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, long value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.long64_att_value(new long[]{value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, long[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.long64_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     * @param asULong  insert data as unsigned int if true as long (DevLong64) if false
     */
    // ===================================================================
    public PipeDataElement(String name, long[]value, boolean asULong) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        if (asULong) {
            final int[] unsigned = new int[value.length];
            for (int i = 0; i < value.length; i++) {
                unsigned[i] = (int) value[i];
            }
            attrValUnion.ulong_att_value(unsigned); //  as unsigned long
        }
        else
            attrValUnion.long64_att_value(value); // as long64
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, float value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.float_att_value(new float[]{value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, float[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.float_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, double value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.double_att_value(new double[] {value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, double [] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.double_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, String value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.string_att_value(new String[] {value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, String[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.string_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }
    // ===================================================================
    // ===================================================================

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, DevState value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.state_att_value(new DevState[]{value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, DevState[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.state_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, DevEncoded value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.encoded_att_value(new DevEncoded[]{value});
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], SCALAR);
    }
    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param value    data element value
     */
    // ===================================================================
    public PipeDataElement(String name, DevEncoded[] value) {
        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.encoded_att_value(value);
        this.element = new DevPipeDataElt(name, attrValUnion, new DevPipeDataElt[0], ARRAY);
    }
    // ===================================================================
    // ===================================================================

    // ===================================================================
    /**
     * Create the PipeDataElement
     * @param name     data element name
     * @param pipeBlob data element value
     */
    // ===================================================================
    public PipeDataElement(String name, PipeBlob pipeBlob) {

        AttrValUnion    attrValUnion = new AttrValUnion();
        attrValUnion.union_no_data(true);
        this.element = new DevPipeDataElt(name,
                attrValUnion,
                pipeBlob.getDevPipeBlobObject().blob_data,
                pipeBlob.getDevPipeBlobObject().name);
    }
    // ===================================================================
    /**
     * Create from an array of values
     * 
     * If data contains array values, i.e. an array of arrays, resulting element will contain PipeBlobs wrapping each array
     * 

     * 
     * int[][]{int[1,2], int[3,4,5]} ->
     *    PipeDataElement[
     *         PipeBlob[
     *             PipeDataElement[int[1,2]], PipeDataElement[int[3,4,5]]]
     * 
     *
     * @param name data element name
     * @param data an array of data element values
     * @throws IllegalArgumentException if data is not an array
     * @throws IllegalArgumentException if data is empty
     * @throws IllegalArgumentException if data's componentType is not one of [String,DevState,DevEncoded,boolean,short,int,long,float,double]. Note wrappers are supported, i.e. Long
     */
    public static PipeDataElement newInstance(String name, Object data) {
        if (!data.getClass().isArray()) throw new IllegalArgumentException("data is expected to be an array!");
        if (Array.getLength(data) == 0) throw new IllegalArgumentException("data can not be empty!");

        Class componentType = data.getClass().getComponentType();

        if (componentType == Object.class) throw new IllegalArgumentException("Can not create PipeBlob from Object[]");

        if (componentType == Boolean.class || componentType == Short.class ||
                componentType == Integer.class || componentType == Long.class ||
                componentType == Float.class || componentType == Double.class) {
            return newInstance(name, ArrayUtils.toPrimitiveArray(data, componentType));
        }

        if (componentType.isArray()) {
            PipeBlobBuilder arrayBlob = new PipeBlobBuilder("array");
            for (int i = 0, size = Array.getLength(data); i < size; ++i) {
                arrayBlob.add(Integer.toString(i), Array.get(data, i));
            }

            return new PipeDataElement(name, arrayBlob.build());
        }

        if (componentType == String.class) {
            return new PipeDataElement(name, (String[]) data);
        } else if (componentType == DevState.class) {
            return new PipeDataElement(name, (DevState[]) data);
        } else if (componentType == DevEncoded.class) {
            return new PipeDataElement(name, (DevEncoded[]) data);
        } else if (componentType == boolean.class) {
            return new PipeDataElement(name, (boolean[]) data);
        } else if (componentType == short.class) {
            return new PipeDataElement(name, (short[]) data);
        } else if (componentType == int.class) {
            return new PipeDataElement(name, (int[]) data);
        } else if (componentType == long.class) {
            return new PipeDataElement(name, (long[]) data);
        } else if (componentType == float.class) {
            return new PipeDataElement(name, (float[]) data);
        } else if (componentType == double.class) {
            return new PipeDataElement(name, (double[]) data);
        } else {
            throw new IllegalArgumentException("An array of ComponentType is not supported: " + componentType.getSimpleName());
        }
    }

    // ===================================================================
    /*
     *  Miscellaneous getters
     */
    // ===================================================================

    // ===================================================================
    // ===================================================================
    private static int getType(DevPipeDataElt element) throws DevFailed {
        int type = -1;
        try {
            //  Check if contains a inner blob
            if (element.inner_blob != null && element.inner_blob.length > 0) {
                return TangoConst.Tango_DEV_PIPE_BLOB;
            }

            //  Else check type from union
            int unionType = element.value.discriminator().value();
            switch (unionType) {
                case AttributeDataType._ATT_BOOL:
                    type = TangoConst.Tango_DEV_BOOLEAN;
                    break;
                case AttributeDataType._ATT_SHORT:
                    type = TangoConst.Tango_DEV_SHORT;
                    break;
                case AttributeDataType._ATT_LONG:
                    type = TangoConst.Tango_DEV_LONG;
                    break;
                case AttributeDataType._ATT_LONG64:
                    type = TangoConst.Tango_DEV_LONG64;
                    break;
                case AttributeDataType._ATT_FLOAT:
                    type = TangoConst.Tango_DEV_FLOAT;
                    break;
                case AttributeDataType._ATT_DOUBLE:
                    type = TangoConst.Tango_DEV_DOUBLE;
                    break;
                case AttributeDataType._ATT_UCHAR:
                    type = TangoConst.Tango_DEV_UCHAR;
                    break;
                case AttributeDataType._ATT_USHORT:
                    type = TangoConst.Tango_DEV_USHORT;
                    break;
                case AttributeDataType._ATT_ULONG:
                    type = TangoConst.Tango_DEV_ULONG;
                    break;
                case AttributeDataType._ATT_ULONG64:
                    type = TangoConst.Tango_DEV_ULONG64;
                    break;
                case AttributeDataType._ATT_STRING:
                    type = TangoConst.Tango_DEV_STRING;
                    break;
                case AttributeDataType._DEVICE_STATE:
                case AttributeDataType._ATT_STATE:
                    type = TangoConst.Tango_DEV_STATE;
                    break;
                case AttributeDataType._ATT_ENCODED:
                    type = TangoConst.Tango_DEV_ENCODED;
                    break;
                case AttributeDataType._ATT_NO_DATA:
                    type = TangoConst.Tango_DEV_VOID;
                    break;

                default:
                    Except.throw_exception("AttributeTypeNotSupported",
                            "Attribute Type (" + unionType + ") Not Supported");
            }
        } catch (final org.omg.CORBA.BAD_PARAM e) {
            Except.throw_exception("Api_TypeCodePackage.BadKind", "Bad or unknown type ");
        }
        return type;
    }
    // ===================================================================
    /**
     * @return the name of data element at index
     */
    // ===================================================================
    public String getName() {
        return element.name;
    }

    /**
     * @return type of data element at specified index.
     */
    // ===================================================================
    public int getType() throws DevFailed {
        return getType(element);
    }
    // ===================================================================
    // ===================================================================





    
    // ===================================================================
    /*
     *  Extract methods
     */
    // ===================================================================

    // ===================================================================
    // ===================================================================
    DevPipeDataElt getDevPipeDataEltObject() {
        return element;
    }
    // ===========================================
    /**
     * extract method for a boolean Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public boolean[] extractBooleanArray() {
        return element.value.bool_att_value();
    }
    // ===========================================
    /**
     * extract method for an unsigned char Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public short[] extractUCharArray() {
        final byte[] argOut = element.value.uchar_att_value();
        final short[] val = new short[argOut.length];
        final short mask = 0xFF;
        for (int i = 0; i < argOut.length; i++) {
            val[i] = (short) (mask & argOut[i]);
        }
        return val;
    }
    // ===========================================
    /**
     * extract method for an unsigned char Array as a char array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public byte[] extractCharArray() {
        return element.value.uchar_att_value();
    }
    // ===========================================
    /**
     * extract method for a short Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public short[] extractShortArray() {
        return element.value.short_att_value();
    }
    // ===========================================
    /**
     * extract method for an unsigned short Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public int[] extractUShortArray() {
        final short[] argOut = element.value.ushort_att_value();
        final int[] val = new int[argOut.length];
        for (int i = 0; i < argOut.length; i++) {
            val[i] = 0xFFFF & argOut[i];
        }
        return val;
    }
    // ===========================================
    /**
     * extract method for a long Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public int[] extractLongArray() {
        return element.value.long_att_value();
    }
    // ===========================================
    /**
     * extract method for a unsigned long.array
     *
     * @return the extracted value.
     */
    // ===========================================
    public long[] extractULongArray() {
        final int[] array = element.value.ulong_att_value();
        long mask = 0x7fffffff;
        mask += (long) 1 << 31;
        final long[] result = new long[array.length];
        for (int i = 0; i < array.length; i++) {
            result[i] = mask & array[i];
        }
        return result;
    }
    // ===========================================
    /**
     * extract method for a long Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public long[] extractLong64Array() {
        return element.value.long64_att_value();
    }
    // ===========================================
    /**
     * extract method for a long Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public long[] extractULong64Array() {
        return element.value.ulong64_att_value();
    }
    // ===========================================
    /**
     * extract method for a float Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public float[] extractFloatArray() {
        return element.value.float_att_value();
    }
    // ===========================================
    /**
     * extract method for a double Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public double[] extractDoubleArray() {
        return element.value.double_att_value();
    }
    // ===========================================
    /**
     * extract method for a double Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public String[] extractStringArray() {
        return element.value.string_att_value();
    }
    // ===========================================

    /**
     * extract method for an DevState Array.
     *
     * @return the extracted value.
     */
    // ===========================================
    public DevState[] extractDevStateArray() throws DevFailed {
        return element.value.state_att_value();
    }

    /**
     * extract method for a DevEncoded[]
     *
     * @return the extracted value.
     */
    // ===========================================
    public DevEncoded[] extractDevEncodedArray() {
        return element.value.encoded_att_value();
    }
    // ===================================================================
    // ===================================================================

    // ===================================================================
    // ===================================================================
    public PipeBlob extractPipeBlob() {
        return new PipeBlob(element.inner_blob_name, element.inner_blob);
    }
    // ===================================================================
    // ===================================================================
}