TANGO Database API

fr.esrf.TangoApi
Class DeviceProxy

java.lang.Object
  |
  +--fr.esrf.TangoApi.Connection
        |
        +--fr.esrf.TangoApi.DeviceProxy

public class DeviceProxy
extends Connection

Class Description: This class manage device connection for Tango objects. It is an api between user and IDL Device object.

Author:
verdier

Constructor Summary
DeviceProxy(java.lang.String devname)
          TangoDevice constructor.
 
Method Summary
 void add_device(DbDevInfo devinfo)
          Add/update this device to the database
 void delete_attribute_property(DbDatum[] properties)
          Delete a list of properties for this object.
 void delete_attribute_property(java.lang.String propname)
          Delete a property for this object.
 void delete_attribute_property(java.lang.String[] propnames)
          Delete a list of properties for this object.
 void delete_device()
          Delete this device from the database
 void delete_property(DbDatum[] properties)
          Delete a list of properties for this device.
 void delete_property(java.lang.String propname)
          Delete a property for this device.
 void delete_property(java.lang.String[] propnames)
          Delete a list of properties for this device.
 void export_device(DbDevExportInfo devinfo)
          Update the export info for this device in the database.
 DbDatum[] get_attribute_property(DbDatum[] properties)
          Query the database for a list of device attribute properties for this device.
 DbDatum get_attribute_property(java.lang.String propname)
          Query the database for a device attribute property for this device.
 DbDatum[] get_attribute_property(java.lang.String[] propnames)
          Query the database for a list of device attribute properties for this device.
 java.lang.String[] get_property_list(java.lang.String wildcard)
          Query the database for a list of device properties for the pecified object.
 DbDatum[] get_property(DbDatum[] properties)
          Query the database for a list of device properties for this device.
 DbDatum get_property(java.lang.String propname)
          Query the database for a device property for this device.
 DbDatum[] get_property(java.lang.String[] propnames)
          Query the database for a list of device properties for this device.
 DbDevImportInfo import_device()
          Query the database for the export info of this device.
 java.lang.String name()
          return the device name.
 void put_attribute_property(DbDatum[] properties)
          Insert or update a list of properties for this device attribute.
 void put_property(DbDatum[] properties)
          Insert or update a list of properties for this device The property names and their values are specified by the DbDatum array.
 
Methods inherited from class fr.esrf.TangoApi.Connection
command_inout, command_inout, command_list_query, get_name, get_tango_host, get_timeout, info, ping, set_timeout
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DeviceProxy

public DeviceProxy(java.lang.String devname)
            throws fr.esrf.Tango.DevFailed
TangoDevice constructor. It will import the device.
Parameters:
devname - name of the device to be imported.
Method Detail

name

public java.lang.String name()
return the device name.

import_device

public DbDevImportInfo import_device()
                              throws fr.esrf.Tango.DevFailed
Query the database for the export info of this device.
Returns:
the information in a DbDevImportInfo.

export_device

public void export_device(DbDevExportInfo devinfo)
                   throws fr.esrf.Tango.DevFailed
Update the export info for this device in the database.
Parameters:
devinfo - Device information to export.

add_device

public void add_device(DbDevInfo devinfo)
                throws fr.esrf.Tango.DevFailed
Add/update this device to the database
Parameters:
devinfo - The device name, class and server specified in object.

delete_device

public void delete_device()
                   throws fr.esrf.Tango.DevFailed
Delete this device from the database

get_property_list

public java.lang.String[] get_property_list(java.lang.String wildcard)
                                     throws fr.esrf.Tango.DevFailed
Query the database for a list of device properties for the pecified object.
Parameters:
wildcard - propertie's wildcard (* matches any charactere).

get_property

public DbDatum[] get_property(java.lang.String[] propnames)
                       throws fr.esrf.Tango.DevFailed
Query the database for a list of device properties for this device.
Parameters:
propnames - list of property names.

get_property

public DbDatum get_property(java.lang.String propname)
                     throws fr.esrf.Tango.DevFailed
Query the database for a device property for this device.
Parameters:
propname - property name.

get_property

public DbDatum[] get_property(DbDatum[] properties)
                       throws fr.esrf.Tango.DevFailed
Query the database for a list of device properties for this device. The property names are specified by the DbDatum array objects.
Parameters:
properties - list of property DbDatum objects.

put_property

public void put_property(DbDatum[] properties)
                  throws fr.esrf.Tango.DevFailed
Insert or update a list of properties for this device The property names and their values are specified by the DbDatum array.
Parameters:
properties - Properties names and values array.

delete_property

public void delete_property(java.lang.String[] propnames)
                     throws fr.esrf.Tango.DevFailed
Delete a list of properties for this device.
Parameters:
propnames - Property names.

delete_property

public void delete_property(java.lang.String propname)
                     throws fr.esrf.Tango.DevFailed
Delete a property for this device.
Parameters:
propname - Property name.

delete_property

public void delete_property(DbDatum[] properties)
                     throws fr.esrf.Tango.DevFailed
Delete a list of properties for this device.
Parameters:
properties - Property DbDatum objects.

put_attribute_property

public void put_attribute_property(DbDatum[] properties)
                            throws fr.esrf.Tango.DevFailed
Insert or update a list of properties for this device attribute. The property names and their values are specified by the DbDatum array.
Parameters:
properties - Properties names and values array.

delete_attribute_property

public void delete_attribute_property(java.lang.String[] propnames)
                               throws fr.esrf.Tango.DevFailed
Delete a list of properties for this object.
Parameters:
propnames - Property names.

delete_attribute_property

public void delete_attribute_property(java.lang.String propname)
                               throws fr.esrf.Tango.DevFailed
Delete a property for this object.
Parameters:
propname - Property name.

delete_attribute_property

public void delete_attribute_property(DbDatum[] properties)
                               throws fr.esrf.Tango.DevFailed
Delete a list of properties for this object.
Parameters:
properties - Property DbDatum objects.

get_attribute_property

public DbDatum[] get_attribute_property(java.lang.String[] propnames)
                                 throws fr.esrf.Tango.DevFailed
Query the database for a list of device attribute properties for this device.
Parameters:
propnames - list of property names.

get_attribute_property

public DbDatum get_attribute_property(java.lang.String propname)
                               throws fr.esrf.Tango.DevFailed
Query the database for a device attribute property for this device.
Parameters:
propname - list of property name.

get_attribute_property

public DbDatum[] get_attribute_property(DbDatum[] properties)
                                 throws fr.esrf.Tango.DevFailed
Query the database for a list of device attribute properties for this device. The property names are specified by the DbDatum array objects.
Parameters:
properties - list of property DbDatum objects.

TANGO Database API