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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JTangoCommons Show documentation
Common classes for tango java API
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: 26328 $
//
//-======================================================================


package fr.esrf.TangoApi;

import fr.esrf.Tango.DevFailed;
import fr.esrf.Tango.DevState;
import fr.esrf.TangoDs.Except;

import java.util.Collections;

/**
 * Class Description:
 * This class manage device connection for Tango attribute access.
 *
 * @author verdier
 * @version $Revision: 26328 $
 */
@SuppressWarnings("UnusedDeclaration")
public class AttributeProxy implements ApiDefs, java.io.Serializable {
    private String full_deviceName = null;
    private String deviceName = null;
    private DeviceProxy dev;
    private int idl_version = -1;

    //===================================================================
    /**
     * AttributeProxy constructor. It will import the device.
     *
     * @param    deviceName    name of the attribute or its alias.
     * @throws DevFailed in case of database access failed
     */
    //===================================================================
    public AttributeProxy(String deviceName) throws DevFailed {
        //	Check if alias or att name
        if (deviceName.indexOf('/') < 0) {
            //	Get the attribute name for specified alias
            String alias = deviceName;
            deviceName = ApiUtil.get_db_obj().get_attribute_from_alias(alias);
        }

        //	Extract device name
        String devname =
                deviceName.substring(0, deviceName.lastIndexOf("/", deviceName.length() - 1));

        //	Store full attribute name
        full_deviceName = deviceName;

        //	Store Tango attribute name
        this.deviceName =
                deviceName.substring(deviceName.lastIndexOf("/", deviceName.length() - 1) + 1);

        String noDB = "#dbase=no";
        if (this.deviceName.endsWith(noDB)) {
            //  Put it at end of device name
            int pos = this.deviceName.indexOf(noDB);
            devname += noDB;
            this.deviceName = this.deviceName.substring(0, pos);
        }

        //	And crate DeviceProxy Object
        dev = DeviceProxyFactory.get(devname);
        //dev = new DeviceProxy(devname);
    }

    //==========================================================================

    /**
     * Just a main method to check API methods.
     */
    //==========================================================================
    public static void main(String args[]) {
        String deviceName = "tango/admin/corvus/hoststate";
        try {
            AttributeProxy att = new AttributeProxy(deviceName);
            att.ping();
            System.out.println(att.name() + " is alive");
            DbAttribute db_att = att.get_property();
            for (int i = 0; i < db_att.size(); i++) {
                DbDatum datum = db_att.datum(i);
                System.out.println(datum.name + " : " + datum.extractString());
            }

            DeviceAttribute da = att.read();
            System.out.println(att.name() + " : " + da.extractShort());
            System.out.println(att.name() + " state  : " + ApiUtil.stateName(att.state()));
            System.out.println(att.name() + " status : " + att.status());
        } catch (DevFailed e) {
            Except.print_exception(e);
        }
    }

    /**
     * Returns the alias name for this attribute
     * @return the alias name for this attribute
     * @throws DevFailed in case of database access failed
     */
    //==========================================================================
    public String get_alias() throws DevFailed {

        //	Then query database for an alias for deviceName.
        return ApiUtil.get_db_obj().get_alias_from_attribute(deviceName);
    }

    //==========================================================================
    //==========================================================================
    public void set_timeout_millis(int millis) throws DevFailed {
        dev.set_timeout_millis(millis);
    }

    //==========================================================================
    //==========================================================================
    public DeviceProxy getDeviceProxy() {
        return dev;
    }
    //==========================================================================

    //==========================================================================
    //==========================================================================
    public int get_idl_version() throws DevFailed {
        if (idl_version < 0)
            idl_version = dev.get_idl_version();
        return idl_version;
    }
    //==========================================================================

    /**
     * Return full attribute name
     */
    //==========================================================================
    public String fullName() {
        return full_deviceName;
    }
    //==========================================================================

    /**
     * Return attribute name
     */
    //==========================================================================
    public String name() {
        return deviceName;
    }
    //==========================================================================

    /**
     * Ping the device proxy of this attribute.
     */
    //==========================================================================
    public long ping() throws DevFailed {
        return dev.ping();
    }
    //==========================================================================

    /**
     * Check state of the device proxy of this attribute.
     */
    //==========================================================================
    public DevState state() throws DevFailed {
        return dev.state();
    }
    //==========================================================================

    /**
     * Check status of the device proxy of this attribute.
     */
    //==========================================================================
    public String status() throws DevFailed {
        return dev.status();
    }
    //==========================================================================

    /**
     * Query the database for a device attribute
     * property for this device.
     *
     * @return property in DbAttribute object.
     */
    //==========================================================================
    public DbAttribute get_property()
            throws DevFailed {
        return dev.get_attribute_property(deviceName);
    }

    //==========================================================================

    /**
     * Insert or update an attribute properties for this device.
     * The property names and their values are specified by the DbAttribute array.
     *
     * @param property attribute  property (names and values).
     */
    //==========================================================================
    public void put_property(DbDatum property)
            throws DevFailed {
        DbAttribute db_att = new DbAttribute(deviceName);
        db_att.add(property);
        dev.put_attribute_property(db_att);
    }

    //==========================================================================

    /**
     * Insert or update an attribute properties for this device.
     * The property names and their values are specified by the DbAttribute array.
     *
     * @param properties attribute  properties (names and values).
     */
    //==========================================================================
    public void put_property(DbDatum[] properties)
            throws DevFailed {
        DbAttribute db_att = new DbAttribute(deviceName);
        Collections.addAll(db_att, properties);
        dev.put_attribute_property(db_att);
    }
    //==========================================================================

    /**
     * Delete a property for this object.
     *
     * @param propname Property name.
     */
    //==========================================================================
    public void delete_property(String propname)
            throws DevFailed {
        dev.delete_attribute_property(deviceName, propname);
    }
    //==========================================================================

    /**
     * Delete a list of properties for this object.
     *
     * @param propnames Property names.
     */
    //==========================================================================
    public void delete_property(String[] propnames)
            throws DevFailed {
        dev.delete_attribute_property(deviceName, propnames);
    }
    //==========================================================================

    /**
     * Get the attribute info.
     *
     * @return the attributes configuration.
     */
    //==========================================================================
    public AttributeInfo get_info() throws DevFailed {
        return dev.get_attribute_info(deviceName);
    }
    //==========================================================================

    /**
     * Update the attributes extended info for the specified device.
     *
     * @param attr the attributes info.
     */
    //==========================================================================
    public void set_info(AttributeInfoEx[] attr) throws DevFailed {
        dev.set_attribute_info(attr);
    }
    //==========================================================================

    /**
     * Get the attribute extended info.
     *
     * @return the attributes configuration.
     */
    //==========================================================================
    public AttributeInfoEx get_info_ex() throws DevFailed {
        return dev.get_attribute_info_ex(deviceName);
    }
    //==========================================================================

    /**
     * Update the attributes info for the specified device.
     *
     * @param attr the attributes info.
     */
    //==========================================================================
    public void set_info(AttributeInfo[] attr) throws DevFailed {
        dev.set_attribute_info(attr);
    }
    //==========================================================================

    /**
     * Read the attribute value for the specified device.
     *
     * @return the attribute value.
     */
    //==========================================================================
    public DeviceAttribute read() throws DevFailed {
        return dev.read_attribute(deviceName);
    }
    // ==========================================================================

    /**
     * Write the attribute value for the specified device.
     *
     * @param devattr attribute name and value.
     */
    //==========================================================================
    public void write(DeviceAttribute devattr) throws DevFailed {
        dev.write_attribute(devattr);
    }
    // ==========================================================================

    /**
     * Write and then read the attribute values, for the specified device.
     *
     * @param devattr attribute names and values.
     */
    // ==========================================================================
    public DeviceAttribute write_read_attribute(DeviceAttribute devattr) throws DevFailed {
        return dev.write_read_attribute(devattr);
    }

    //==========================================================================

    /**
     * Write and then read the attribute values, for the specified device.
     *
     * @param devattr attribute names and values.
     */
    // ==========================================================================
    public DeviceAttribute[] write_read_attribute(DeviceAttribute[] devattr) throws DevFailed {
        return dev.write_read_attribute(devattr);
    }
    //==========================================================================

    /**
     * Return the history for attribute polled.
     *
     * @param    nb        nb data to read.
     */
    //==========================================================================
    public DeviceDataHistory[] history(int nb) throws DevFailed {
        return dev.attribute_history(deviceName, nb);
    }
    //==========================================================================

    /**
     * Return the full history for attribute polled.
     */
    //==========================================================================
    public DeviceDataHistory[] history() throws DevFailed {
        return dev.attribute_history(deviceName);
    }
    //==========================================================================

    /**
     * Add a attribute to be polled for the device.
     * If already polled, update its polling period.
     *
     * @param    period    polling period.
     */
    //==========================================================================
    public void poll(int period) throws DevFailed {
        dev.poll_attribute(deviceName, period);
    }
    //==========================================================================

    /**
     * Returns the polling period (in ms) for specified attribute.
     */
    //==========================================================================
    public int get_polling_period() throws DevFailed {
        return dev.get_attribute_polling_period(deviceName);
    }
    //==========================================================================

    /**
     * Remove attribute of polled object list
     */
    //==========================================================================
    public void stop_poll() throws DevFailed {
        dev.stop_poll_attribute(deviceName);
    }
    //==========================================================================

    /**
     * Asynchronous read_attribute.
     */
    //==========================================================================
    public int read_asynch() throws DevFailed {
        return dev.read_attribute_asynch(deviceName);
    }
    //==========================================================================

    /**
     * Asynchronous read_attribute using callback for reply.
     *
     * @param    cb        a CallBack object instance.
     */
    //==========================================================================
    public void read_asynch(CallBack cb) throws DevFailed {
        dev.read_attribute_asynch(deviceName, cb);
    }
    //==========================================================================

    /**
     * Read Asynchronous read_attribute reply.
     *
     * @param    id    asynchronous call id (returned by read_attribute_asynch).
     * @param    timeout    number of milliseconds to wait reply before throw an excption.
     */
    //==========================================================================
    public DeviceAttribute[] read_reply(int id, int timeout) throws DevFailed {
        return dev.read_attribute_reply(id, timeout);
    }
    //==========================================================================

    /**
     * Read Asynchronous read_attribute reply.
     *
     * @param    id    asynchronous call id (returned by read_attribute_asynch).
     */
    //==========================================================================
    public DeviceAttribute[] read_reply(int id) throws DevFailed {
        return dev.read_attribute_reply(id);
    }
    //==========================================================================

    /**
     * Asynchronous write_attribute.
     *
     * @param    attr    Attribute value (name, writing value...)
     */
    //==========================================================================
    public int write_asynch(DeviceAttribute attr) throws DevFailed {
        return dev.write_attribute_asynch(attr);
    }
    //==========================================================================

    /**
     * Asynchronous write_attribute.
     *
     * @param    attr    Attribute value (name, writing value...)
     * @param    forget    forget the response if true
     */
    //==========================================================================
    public int write_asynch(DeviceAttribute attr, boolean forget) throws DevFailed {
        return dev.write_attribute_asynch(attr, forget);
    }
    //==========================================================================

    /**
     * Asynchronous write_attribute using callback for reply.
     *
     * @param    attr    Attribute values (name, writing value...)
     * @param    cb        a CallBack object instance.
     */
    //==========================================================================
    public void write_asynch(DeviceAttribute attr, CallBack cb)  throws DevFailed {
        dev.write_attribute_asynch(attr, cb);
    }
    //==========================================================================

    /**
     * check for Asynchronous write_attribute reply.
     *
     * @param    id    asynchronous call id (returned by read_attribute_asynch).
     */
    //==========================================================================
    public void write_reply(int id) throws DevFailed {
        dev.write_attribute_reply(id);
    }
    //==========================================================================

    /**
     * check for Asynchronous write_attribute reply.
     *
     * @param    id    asynchronous call id (returned by write_attribute_asynch).
     * @param    timeout    number of milliseconds to wait reply before throw an excption.
     */
    //==========================================================================
    public void write_reply(int id, int timeout) throws DevFailed {
        dev.write_attribute_reply(id, timeout);
    }
    //==========================================================================
    //==========================================================================


    //==========================================================================

    /**
     * Subscribe to an event.
     *
     * @param callback event callback.
     * @param    event event name.
     */
    //==========================================================================
    public int subscribe_event(int event, CallBack callback, String[] filters) throws DevFailed {
        return dev.subscribe_event(deviceName, event, callback, filters);
    }
}