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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of TangORB Show documentation
Java API for Tango
There is a newer version: 10.0.0
//+======================================================================
// $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: 28442 $
//
//-======================================================================


package fr.esrf.TangoApi;

import fr.esrf.Tango.*;
import fr.esrf.TangoDs.Except;
import fr.esrf.TangoDs.TangoConst;
import org.omg.CORBA.Any;
import org.omg.CORBA.ORB;
import org.omg.CORBA.TCKind;
import org.omg.CORBA.TypeCode;

/**
 * Class Description: This class manage data object for Tango device access.
 * 
 * 

 * 

 * 

 *  Usage example:  

 * 

 *  String status; 

 * DeviceProxy dev = DeviceProxyFactory.get("sys/steppermotor/1"); 

 * try { 

 * 
 * DeviceData data = dev.command_inout("DevStatus"); 

 * status = data.extractString(); 

 * 
 * } 

 * catch (DevFailed e) { 

 * 
 * status = "Unknown status"; 

 * Except.print_exception(e); 

 * 
 * } 

 * 
 *
 * @author verdier
 * @version $Revision: 28442 $
 */

public class DeviceDataDAODefaultImpl implements TangoConst, IDeviceDataDAO {

    public DeviceDataDAODefaultImpl() {
    }

    // ===========================================================
    /**
     * Constructor for the TgApi Data Object.
     *
     * @throws DevFailed if TgApi class not instancied.
     */
    // ===========================================================
    public void init(final DeviceData deviceData) throws DevFailed {
        deviceData.setAny(ApiUtil.get_orb().create_any());
    }
    // ===========================================================
    /**
     * Constructor for the TgApi Data Object.
     *
     * @param orb orb connection id.
     * @throws DevFailed if TgApi class not instancied.
     */
    // ===========================================================
    public void init(final DeviceData deviceData, final ORB orb) throws DevFailed {
        deviceData.setAny(orb.create_any());
    }
    // ===========================================================
    /**
     * Constructor for the TgApi Data Object.
     *
     * @param any CORBA Any reference to be used in DeviceData.
     * @throws DevFailed if TgApi class not instancied.
     */
    // ===========================================================
    public void init(final DeviceData deviceData, final Any any) throws DevFailed {
        deviceData.setAny(any);
    }

    // ********** Insert Methods for basic types *********************

    // ===========================================
    /**
     * Insert method for argin is void.
     */
    // ===========================================
    public void insert(final DeviceData deviceData) {
    }
    // ===========================================
    /**
     * Insert method for argin is Any (CORBA).
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final Any any) {
        deviceData.setAny(any);
    }
    // ===========================================
    /**
     * Insert method for argin is boolean.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final boolean argin) {
        DevBooleanHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is short.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final short argin) {
        DevShortHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is long (64 bits)
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final long argin) {
        DevLong64Helper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is int.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final int argin) {
        DevLongHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is float.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final float argin) {
        DevFloatHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is double.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final double argin) {
        DevDoubleHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is String.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final String argin) {
        DevStringHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevState.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final DevState argin) {
        DevStateHelper.insert(deviceData.getAny(), argin);
    }

    // ********** Insert Methods for sequence types *********************

    // ===========================================
    /**
     * Insert method for argin is DevVarCharArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final byte[] argin) {
        DevVarCharArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevVarShortArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final short[] argin) {
        DevVarShortArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevVarLongArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final int[] argin) {
        DevVarLongArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is long array (64 bits).
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final long[] argin) {
        DevVarLong64ArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevVarFloatArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final float[] argin) {
        DevVarFloatArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevVarDoubleArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final double[] argin) {
        DevVarDoubleArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevVarStringArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final String[] argin) {
        DevVarStringArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevVarLongStringArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final DevVarLongStringArray argin) {
        DevVarLongStringArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is DevVarDoubleStringArray.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert(final DeviceData deviceData, final DevVarDoubleStringArray argin) {
        DevVarDoubleStringArrayHelper.insert(deviceData.getAny(), argin);
    }

    // ********** Insert Methods for unsigned types *********************

    // ===========================================
    /**
     * Insert method for argin is unsigned long 64.array
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_u64(final DeviceData deviceData, final long[] argin) {
        DevVarULong64ArrayHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is unsigned long 64.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_u64(final DeviceData deviceData, final long argin) {
        DevULong64Helper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin int as unsigned char.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_uc(final DeviceData deviceData, final short argin) {
        final byte val = (byte) (argin & 0xFF);
        DevUCharHelper.insert(deviceData.getAny(), val);
    }
    // ===========================================
    /**
     * Insert method for argin is unsigned char.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_uc(final DeviceData deviceData, final byte argin) {
        DevUCharHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin int as unsigned short.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_us(final DeviceData deviceData, final int argin) {
        final short val = (short) (argin & 0xFFFF);
        DevUShortHelper.insert(deviceData.getAny(), val);
    }
    // ===========================================
    /**
     * Insert method for argin is unsigned short.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_us(final DeviceData deviceData, final short argin) {
        DevUShortHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is unsigned short.
     *
     * @param argin argin value for next command.
     * @deprecated use insert_us(short/int argin)
     */
    // ===========================================
    @Deprecated
    public void insert_u(final DeviceData deviceData, final short argin) {
        DevUShortHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin long ass unsigned int.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_ul(final DeviceData deviceData, final long argin) {
        final int val = (int) (argin & 0xFFFFFFFF);
        DevULongHelper.insert(deviceData.getAny(), val);
    }
    // ===========================================
    /**
     * Insert method for argin is unsigned int.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_ul(final DeviceData deviceData, final int argin) {
        DevULongHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin is unsigned int.
     *
     * @param argin argin value for next command.
     * @deprecated use insert_ul(int/long argin)
     */
    // ===========================================
    @Deprecated
    public void insert_u(final DeviceData deviceData, final int argin) {
        DevULongHelper.insert(deviceData.getAny(), argin);
    }
    // ===========================================
    /**
     * Insert method for argin int as unsigned short array.
     *
     * @param argin argin value for next command.
     */
    // ===========================================
    public void insert_us(final DeviceData deviceData, final int[] argin) {
        final short[] val = new short[argin.length];
        for (int i = 0 ; i