fr.soleil.tango.clientapi.TangoGroupAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of JTangoClientLang Show documentation
Tango client utilities
There is a newer version: 10.0.0
package fr.soleil.tango.clientapi;

import java.util.Arrays;
import java.util.Map;

import org.apache.commons.lang3.builder.ToStringBuilder;
import org.tango.utils.DevFailedUtils;

import fr.esrf.Tango.DevError;
import fr.esrf.Tango.DevFailed;
import fr.esrf.TangoApi.AttributeInfoEx;
import fr.esrf.TangoApi.DeviceAttribute;
import fr.esrf.TangoApi.Group.AttributeGroup;
import fr.soleil.tango.clientapi.factory.ProxyFactory;

public final class TangoGroupAttribute {

    private final AttributeGroup group;
    private final String[] attributeNamesGroup;
    private DeviceAttribute[] deviceAttributes;

    /**
     * Build the group and read attributes
     *
     * @param attributeNames
     * @throws DevFailed
     */
    public TangoGroupAttribute(final String... attributeNames) throws DevFailed {
        attributeNamesGroup = attributeNames;
        group = ProxyFactory.getInstance().createAttributeGroup(true, attributeNames);
        deviceAttributes = group.read();
    }

    /**
     *
     *
     * @param throwExceptions
     * @param attributeNames
     * @throws DevFailed
     */
    public TangoGroupAttribute(final boolean throwExceptions, final String... attributeNames) throws DevFailed {
        this(throwExceptions, true, attributeNames);

    }

    /**
     * @param groupName
     * @param throwExceptions
     * @param attributeNames
     * @throws DevFailed
     */
    public TangoGroupAttribute(final boolean throwExceptions, final boolean readValue, final String... attributeNames)
            throws DevFailed {
        attributeNamesGroup = attributeNames;
        group = ProxyFactory.getInstance().createAttributeGroup(throwExceptions, attributeNames);
        if (readValue) {
            initDeviceAttributes();
        }

    }

    private void initDeviceAttributes() throws DevFailed {
        if (deviceAttributes == null) {
            deviceAttributes = group.read();
            if (deviceAttributes.length != attributeNamesGroup.length) {
                deviceAttributes = null;
                throw DevFailedUtils.newDevFailed("Some attributes are not available");
            }
        }
    }

    /**
     * Write a value on several attributes
     *
     * @param value
     *            Can be an array
     * @throws DevFailed
     */
    public void write(final Object value) throws DevFailed {
        initDeviceAttributes();

        for (final DeviceAttribute deviceAttribute : deviceAttributes) {
            if (deviceAttribute != null) {
                // may be null if read failed and throwExceptions is false
                InsertExtractUtils.insert(deviceAttribute, value);
            }
        }
        group.write(deviceAttributes);
    }

    public void writeAysn(final Object value) throws DevFailed {
        initDeviceAttributes();

        for (final DeviceAttribute deviceAttribute : deviceAttributes) {
            if (deviceAttribute != null) {
                // may be null if read failed and throwExceptions is false
                InsertExtractUtils.insert(deviceAttribute, value);
            }
        }
        group.writeAsync(deviceAttributes);
    }

    /**
     * Write a value on several attribute
     *
     * @param value
     *            Can be an array
     * @throws DevFailed
     */
    public void write(final Object... value) throws DevFailed {
        writeAysn(value);
        getWriteAsyncReplies();
    }

    public void writeAysn(final Object... value) throws DevFailed {
        if (deviceAttributes == null) {
            deviceAttributes = group.read();
        }
        if (value.length != deviceAttributes.length) {
            throw DevFailedUtils.newDevFailed("WRITE_ERROR", deviceAttributes.length + " values must be provided");
        }
        int i = 0;
        for (final DeviceAttribute deviceAttribute : deviceAttributes) {
            InsertExtractUtils.insert(deviceAttribute, value[i++]);
        }
        group.writeAsync(deviceAttributes);
    }

    public void getWriteAsyncReplies() throws DevFailed {
        group.getWriteReplies();
    }

    /**
     * Read all attributes of the group. WARN: does not throw errors. It will be thrown at extraction on DeviceAttribute
     *
     * @return
     * @throws DevFailed
     */
    public DeviceAttribute[] read() throws DevFailed {
        return group.read();
    }

    /**
     * Read attributes and extract their values
     *
     * @return an array of objects. Same size as the number of attributes. Contains READ and WRITE parts
     * @throws DevFailed
     */
    public Object[] readExtract() throws DevFailed {
        final DeviceAttribute[] da = read();
        final Object[] results = extract(da);
        return results;
    }

    public Object[] extract(final DeviceAttribute[] da) throws DevFailed {
        final Object[] results = new Object[da.length];
        for (int i = 0; i < results.length; i++) {
            results[i] = InsertExtractUtils.extract(da[i]);
        }
        return results;
    }

    /**
     * Launch read asynchronously. Get replies with {@link TangoGroupAttribute#getAsyncReplies()}
     *
     * @throws DevFailed
     */
    public void readAync() throws DevFailed {
        group.readAsync();
    }

    /**
     * Get replies of last call to {@link TangoGroupAttribute#readAync()}
     *
     * @return
     * @throws DevFailed
     */
    public DeviceAttribute[] getReadAsyncReplies() throws DevFailed {
        return group.getReadReplies();
    }

    /**
     * @return The attributes configuration @see {@link AttributeInfoEx}
     * @throws DevFailed
     */
    public AttributeInfoEx[] getConfig() throws DevFailed {
        return group.getConfig();
    }

    /**
     * Get last occured error
     *
     * @return a map with the attribute name as a key and its error as value
     */
    public Map getErrors() {
        return group.getErrors();
    }

    public boolean hasFailed() {
        return group.hasFailed();
    }

    @Override
    public String toString() {
        final ToStringBuilder str = new ToStringBuilder(this);
        str.append("names", Arrays.toString(attributeNamesGroup));
        return str.toString();
    }

    public AttributeGroup getGroup() {
        return group;
    }

    public boolean isThrowExceptions() {
        return group.isThrowExceptions();
    }

    public void setTimeout(final int timeout) {
        group.setTimeout(timeout);
    }
}