fr.esrf.TangoApi
Interface IDeviceProxyDAO

All Superinterfaces:

IConnectionDAO

All Known Implementing Classes:

DeviceProxyDAODefaultImpl

public interface IDeviceProxyDAO
extends IConnectionDAO

Method Summary

void	add_device(DeviceProxy deviceProxy, DbDevInfo devinfo) Add/update this device to the database
void	add_logging_target(DeviceProxy deviceProxy, java.lang.String target) Adds a new logging target to the device.
DeviceDataHistory[]	attribute_history(DeviceProxy deviceProxy, java.lang.String attname) Return the full history for attribute polled.
DeviceDataHistory[]	attribute_history(DeviceProxy deviceProxy, java.lang.String attname, int nb) Return the history for attribute polled.
void	check_asynch_reply(DeviceProxy deviceProxy, org.omg.CORBA.Request request, int id, java.lang.String idl_cmd) Check Asynchronous call reply.
DeviceDataHistory[]	command_history(DeviceProxy deviceProxy, java.lang.String cmdname) Return the full history for command polled.
DeviceDataHistory[]	command_history(DeviceProxy deviceProxy, java.lang.String cmdname, int nb) Return the history for command polled.
int	command_inout_asynch(DeviceProxy deviceProxy, java.lang.String cmdname) Asynchronous command_inout.
int	command_inout_asynch(DeviceProxy deviceProxy, java.lang.String cmdname, boolean forget) Asynchronous command_inout.
void	command_inout_asynch(DeviceProxy deviceProxy, java.lang.String cmdname, CallBack cb) Asynchronous command_inout using callback for reply.
int	command_inout_asynch(DeviceProxy deviceProxy, java.lang.String cmdname, DeviceData data_in) Asynchronous command_inout.
int	command_inout_asynch(DeviceProxy deviceProxy, java.lang.String cmdname, DeviceData data_in, boolean forget) Asynchronous command_inout.
void	command_inout_asynch(DeviceProxy deviceProxy, java.lang.String cmdname, DeviceData argin, CallBack cb) Asynchronous command_inout using callback for reply.
DeviceData	command_inout_reply(DeviceProxy deviceProxy, fr.esrf.TangoApi.AsyncCallObject aco) Read Asynchronous command_inout reply.
DeviceData	command_inout_reply(DeviceProxy deviceProxy, fr.esrf.TangoApi.AsyncCallObject aco, int timeout) Read Asynchronous command_inout reply.
DeviceData	command_inout_reply(DeviceProxy deviceProxy, int id) Read Asynchronous command_inout reply.
DeviceData	command_inout_reply(DeviceProxy deviceProxy, int id, int timeout) Read Asynchronous command_inout reply.
CommandInfo	command_query(DeviceProxy deviceProxy, java.lang.String cmdname) return the IDL device command_query for the specified command.
void	delete_attribute_property(DeviceProxy deviceProxy, DbAttribute attr) Delete a list of properties for this object.
void	delete_attribute_property(DeviceProxy deviceProxy, DbAttribute[] attr) Delete a list of properties for this object.
void	delete_attribute_property(DeviceProxy deviceProxy, java.lang.String attname, java.lang.String propname) Delete a property for this object.
void	delete_attribute_property(DeviceProxy deviceProxy, java.lang.String attname, java.lang.String[] propnames) Delete a list of properties for this object.
void	delete_attribute(DeviceProxy deviceProxy, java.lang.String attname) Delete an attribute for this object.
void	delete_device(DeviceProxy deviceProxy) Delete this device from the database
void	delete_property(DeviceProxy deviceProxy, DbDatum[] properties) Delete a list of properties for this device.
void	delete_property(DeviceProxy deviceProxy, java.lang.String propname) Delete a property for this device.
void	delete_property(DeviceProxy deviceProxy, java.lang.String[] propnames) Delete a list of properties for this device.
java.lang.String[]	dev_inform(DeviceProxy deviceProxy) Returns TACO device information.
void	export_device(DeviceProxy deviceProxy, DbDevExportInfo devinfo) Update the export info for this device in the database.
DeviceProxy	get_adm_dev(DeviceProxy deviceProxy)
java.lang.String	get_alias(DeviceProxy deviceProxy) Get alias for the device
java.lang.String	get_asynch_idl_cmd(DeviceProxy deviceProxy, org.omg.CORBA.Request request, java.lang.String idl_cmd) Retrieve the command/attribute arguments to build exception description.
void	get_asynch_replies(DeviceProxy deviceProxy) Fire callback methods for all asynchronous requests(cmd and attr) with already arrived replies.
void	get_asynch_replies(DeviceProxy deviceProxy, int timeout) Fire callback methods for all asynchronous requests(cmd and attr) with already arrived replies.
AttributeInfo[]	get_attribute_config(DeviceProxy deviceProxy) Deprecated. use get_attribute_info()
AttributeInfo	get_attribute_config(DeviceProxy deviceProxy, java.lang.String attname) Deprecated. use get_attribute_info(String attname)
AttributeInfo[]	get_attribute_config(DeviceProxy deviceProxy, java.lang.String[] attnames) Deprecated. use get_attribute_info(String[] attnames)
AttributeInfoEx[]	get_attribute_info_ex(DeviceProxy deviceProxy) Get all attributes info for the specified device.
AttributeInfoEx	get_attribute_info_ex(DeviceProxy deviceProxy, java.lang.String attname) Get the attribute info for the specified device.
AttributeInfoEx[]	get_attribute_info_ex(DeviceProxy deviceProxy, java.lang.String[] attnames) Get the extended attributes configuration for the specified device.
AttributeInfo[]	get_attribute_info(DeviceProxy deviceProxy) Get all attributes info for the specified device.
AttributeInfo	get_attribute_info(DeviceProxy deviceProxy, java.lang.String attname) Get the attribute info for the specified device.
AttributeInfo[]	get_attribute_info(DeviceProxy deviceProxy, java.lang.String[] attnames) Get the attributes configuration for the specified device.
java.lang.String[]	get_attribute_list(DeviceProxy deviceProxy) Query the device for attribute config and returns names only.
int	get_attribute_polling_period(DeviceProxy deviceProxy, java.lang.String attname) Returns the polling period (in ms) for specified attribute.
DbAttribute	get_attribute_property(DeviceProxy deviceProxy, java.lang.String attname) Query the database for a device attribute property for this device.
DbAttribute[]	get_attribute_property(DeviceProxy deviceProxy, java.lang.String[] attnames) Query the database for a list of device attribute properties for this device.
java.lang.String[]	get_class_inheritance(DeviceProxy deviceProxy) Returns the class inheritance for the device [0] Device Class [1] Class from the device class is inherited.
java.lang.String	get_class(DeviceProxy deviceProxy) Returns the class for the device
int	get_command_polling_period(DeviceProxy deviceProxy, java.lang.String cmdname) Returns the polling period (in ms) for specified command.
Database	get_db_obj(DeviceProxy deviceProxy)
DeviceInfo	get_info(DeviceProxy deviceProxy) Query the database for the info of this device.
int	get_logging_level(DeviceProxy deviceProxy) get logging level from the device.
java.lang.String[]	get_logging_target(DeviceProxy deviceProxy) get logging target from the device.
java.lang.String[]	get_property_list(DeviceProxy deviceProxy, java.lang.String wildcard) Query the database for a list of device properties for the pecified object.
DbDatum[]	get_property(DeviceProxy deviceProxy, DbDatum[] properties) Query the database for a list of device properties for this device.
DbDatum	get_property(DeviceProxy deviceProxy, java.lang.String propname) Query the database for a device property for this device.
DbDatum[]	get_property(DeviceProxy deviceProxy, java.lang.String[] propnames) Query the database for a list of device properties for this device.
int	get_rpc_protocol(DeviceProxy deviceProxy)
LockerInfo	getLockerInfo(DeviceProxy deviceProxy) Returns the device lock info
java.lang.String	getLockerStatus(DeviceProxy deviceProxy) Returns the device lock status
void	import_admin_device(DeviceProxy deviceProxy, DbDevImportInfo info) Get connection on administration device.
void	import_admin_device(DeviceProxy deviceProxy, java.lang.String origin) Get connection on administration device.
DbDevImportInfo	import_device(DeviceProxy deviceProxy) Query the database for the export info of this device.
void	init(DeviceProxy deviceProxy) Default DeviceProxy constructor.
void	init(DeviceProxy deviceProxy, java.lang.String devname) DeviceProxy constructor.
void	init(DeviceProxy deviceProxy, java.lang.String devname, boolean check_access) DeviceProxy constructor.
void	init(DeviceProxy deviceProxy, java.lang.String devname, java.lang.String ior) TangoDevice constructor.
void	init(DeviceProxy deviceProxy, java.lang.String devname, java.lang.String host, java.lang.String port) TangoDevice constructor.
boolean	isLocked(DeviceProxy deviceProxy) Returns true if the device is locked
boolean	isLockedByMe(DeviceProxy deviceProxy) Returns true if the device is locked by this process
void	lock(DeviceProxy deviceProxy, int validity) Lock the device
void	main(java.lang.String[] args) Just a main method to check API methods.
java.lang.String	name(DeviceProxy deviceProxy) return the device name.
int	pending_asynch_call(DeviceProxy deviceProxy, int reply_model) return the still pending asynchronous call for a reply model.
void	poll_attribute(DeviceProxy deviceProxy, java.lang.String attname, int period) Add a attribute to be polled for the device.
void	poll_command(DeviceProxy deviceProxy, java.lang.String cmdname, int period) Add a command to be polled for the device.
java.lang.String[]	polling_status(DeviceProxy deviceProxy) Returns the polling status for the device.
void	put_alias(DeviceProxy deviceProxy, java.lang.String aliasname) Set an alias for a device name
void	put_attribute_property(DeviceProxy deviceProxy, DbAttribute attr) Insert or update an attribute properties for this device.
void	put_attribute_property(DeviceProxy deviceProxy, DbAttribute[] attr) Insert or update a list of attribute properties for this device.
void	put_property(DeviceProxy deviceProxy, DbDatum prop) Insert or update a property for this device The property name and its value are specified by the DbDatum
void	put_property(DeviceProxy deviceProxy, DbDatum[] properties) Insert or update a list of properties for this device The property names and their values are specified by the DbDatum array.
int	read_attribute_asynch(DeviceProxy deviceProxy, java.lang.String attname) Asynchronous read_attribute.
int	read_attribute_asynch(DeviceProxy deviceProxy, java.lang.String[] attnames) Asynchronous read_attribute.
void	read_attribute_asynch(DeviceProxy deviceProxy, java.lang.String[] attnames, CallBack cb) Asynchronous read_attribute using callback for reply.
void	read_attribute_asynch(DeviceProxy deviceProxy, java.lang.String attname, CallBack cb) Asynchronous read_attribute using callback for reply.
DeviceAttribute[]	read_attribute_reply(DeviceProxy deviceProxy, int id) Read Asynchronous read_attribute reply.
DeviceAttribute[]	read_attribute_reply(DeviceProxy deviceProxy, int id, int timeout) Read Asynchronous read_attribute reply.
AttributeValue	read_attribute_value(DeviceProxy deviceProxy, java.lang.String attname)
DeviceAttribute	read_attribute(DeviceProxy deviceProxy, java.lang.String attname) Read the attribute value for the specified device.
DeviceAttribute[]	read_attribute(DeviceProxy deviceProxy, java.lang.String[] attnames) Read the attribute values for the specified device.
void	remove_logging_target(DeviceProxy deviceProxy, java.lang.String target_type, java.lang.String target_name) Removes a new logging target to the device.
void	set_attribute_config(DeviceProxy deviceProxy, AttributeInfo[] attr) Deprecated. use set_attribute_info(AttributeInfo[] attr)
void	set_attribute_info(DeviceProxy deviceProxy, AttributeInfo[] attr) Update the attributes info for the specified device.
void	set_attribute_info(DeviceProxy deviceProxy, AttributeInfoEx[] attr) Update the attributes extended info for the specified device.
void	set_logging_level(DeviceProxy deviceProxy, int level) Set logging level from the device.
void	set_rpc_protocol(DeviceProxy deviceProxy, int mode) Execute the dev_rpc_protocol TACO command to change RPC protocol mode.
DevState	state(DeviceProxy deviceProxy) return the device state read from CORBA attribute.
DevState	state(DeviceProxy deviceProxy, boolean src) return the device state.
java.lang.String	status(DeviceProxy deviceProxy) return the device status read from CORBA attribute.
java.lang.String	status(DeviceProxy deviceProxy, boolean src) return the device status.
void	stop_poll_attribute(DeviceProxy deviceProxy, java.lang.String attname) Remove attribute of polled object list
void	stop_poll_command(DeviceProxy deviceProxy, java.lang.String cmdname) Remove command of polled object list
int	subscribe_event(DeviceProxy deviceProxy, java.lang.String attr_name, int event, CallBack callback, java.lang.String[] filters, boolean stateless) Subscribe to an event.
int	subscribe_event(DeviceProxy deviceProxy, java.lang.String attr_name, int event, int max_size, java.lang.String[] filters, boolean stateless) Subscribe to event to be stored in an event queue.
void	unexport_device(DeviceProxy deviceProxy) Unexport the device in database.
int	unlock(DeviceProxy deviceProxy) Unlock the device
void	unsubscribe_event(DeviceProxy deviceProxy, int event_id) Unsubscribe to an event.
boolean	use_db(DeviceProxy deviceProxy)
int	write_attribute_asynch(DeviceProxy deviceProxy, DeviceAttribute attr) Asynchronous write_attribute.
int	write_attribute_asynch(DeviceProxy deviceProxy, DeviceAttribute[] attribs) Asynchronous write_attribute.
int	write_attribute_asynch(DeviceProxy deviceProxy, DeviceAttribute[] attribs, boolean forget) Asynchronous write_attribute.
void	write_attribute_asynch(DeviceProxy deviceProxy, DeviceAttribute[] attribs, CallBack cb) Asynchronous write_attribute using callback for reply.
int	write_attribute_asynch(DeviceProxy deviceProxy, DeviceAttribute attr, boolean forget) Asynchronous write_attribute.
void	write_attribute_asynch(DeviceProxy deviceProxy, DeviceAttribute attr, CallBack cb) Asynchronous write_attribute using callback for reply.
void	write_attribute_reply(DeviceProxy deviceProxy, int id) check for Asynchronous write_attribute reply.
void	write_attribute_reply(DeviceProxy deviceProxy, int id, int timeout) check for Asynchronous write_attribute reply.
void	write_attribute(DeviceProxy deviceProxy, DeviceAttribute devattr) Write the attribute value for the specified device.
void	write_attribute(DeviceProxy deviceProxy, DeviceAttribute[] devattr) Write the attribute values for the specified device.
DeviceAttribute[]	write_read_attribute(DeviceProxy deviceProxy, DeviceAttribute[] devattr) Write and then read the attribute values, for the specified device.

Methods inherited from interface fr.esrf.TangoApi.IConnectionDAO

adm_name, black_box, build_connection, checkIfTaco, checkIfTango, command_inout, command_inout, command_list_query, description, dev_import, get_class_name, get_device, get_host_name, get_idl_version, get_ior, get_name, get_server_name, get_source, get_tango_host, get_timeout_millis, get_timeout, get_transparency_reconnection, getAccessControl, info_3, info, init, init, init, init, init, init, init, init, is_taco, isAllowedCommand, ping, set_source, set_timeout_millis, set_transparency_reconnection, setAccessControl, throw_dev_failed

Method Detail

init

void init(DeviceProxy deviceProxy)
          throws DevFailed

Default DeviceProxy constructor. It will do nothing

Throws:

DevFailed

init

void init(DeviceProxy deviceProxy,
          java.lang.String devname)
          throws DevFailed

DeviceProxy constructor. It will import the device.

Parameters:

devname - name of the device to be imported.

Throws:

DevFailed

init

void init(DeviceProxy deviceProxy,
          java.lang.String devname,
          boolean check_access)
          throws DevFailed

DeviceProxy constructor. It will import the device.

Parameters:

devname - name of the device to be imported.

check_access - set check_access value

Throws:

DevFailed

init

void init(DeviceProxy deviceProxy,
          java.lang.String devname,
          java.lang.String ior)
          throws DevFailed

TangoDevice constructor. It will import the device.

Parameters:

devname - name of the device to be imported.

ior - ior string used to import device

Throws:

DevFailed

init

void init(DeviceProxy deviceProxy,
          java.lang.String devname,
          java.lang.String host,
          java.lang.String port)
          throws DevFailed

TangoDevice constructor. It will import the device.

Parameters:

devname - name of the device to be imported.

host - host where database is running.

port - port for database connection.

Throws:

DevFailed

use_db

boolean use_db(DeviceProxy deviceProxy)

get_db_obj

Database get_db_obj(DeviceProxy deviceProxy)
                    throws DevFailed

Throws:

DevFailed

import_admin_device

void import_admin_device(DeviceProxy deviceProxy,
                         DbDevImportInfo info)
                         throws DevFailed

Get connection on administration device.

Throws:

DevFailed

import_admin_device

void import_admin_device(DeviceProxy deviceProxy,
                         java.lang.String origin)
                         throws DevFailed

Get connection on administration device.

Throws:

DevFailed

name

java.lang.String name(DeviceProxy deviceProxy)

return the device name.

status

java.lang.String status(DeviceProxy deviceProxy)
                        throws DevFailed

return the device status read from CORBA attribute.

Throws:

DevFailed

status

java.lang.String status(DeviceProxy deviceProxy,
                        boolean src)
                        throws DevFailed

return the device status.

Parameters:

src - Source to read status. It could be ApiDefs.FROM_CMD to read it from a command_inout or ApiDefs.FROM_ATTR to read it from CORBA attribute.

Throws:

DevFailed

state

DevState state(DeviceProxy deviceProxy)
               throws DevFailed

return the device state read from CORBA attribute.

Throws:

DevFailed

state

DevState state(DeviceProxy deviceProxy,
               boolean src)
               throws DevFailed

return the device state.

Parameters:

src - Source to read state. It could be ApiDefs.FROM_CMD to read it from a command_inout or ApiDefs.FROM_ATTR to read it from CORBA attribute.

Throws:

DevFailed

command_query

CommandInfo command_query(DeviceProxy deviceProxy,
                          java.lang.String cmdname)
                          throws DevFailed

return the IDL device command_query for the specified command.

Parameters:

cmdname - command name to be used for the command_query

Returns:

the command information..

Throws:

DevFailed

get_class

java.lang.String get_class(DeviceProxy deviceProxy)
                           throws DevFailed

Returns the class for the device

Throws:

DevFailed

get_class_inheritance

java.lang.String[] get_class_inheritance(DeviceProxy deviceProxy)
                                         throws DevFailed

Returns the class inheritance for the device

• [0] Device Class
• [1] Class from the device class is inherited.
• .....And so on

Throws:

DevFailed

put_alias

void put_alias(DeviceProxy deviceProxy,
               java.lang.String aliasname)
               throws DevFailed

Set an alias for a device name

Parameters:

aliasname - alias name.

Throws:

DevFailed

get_alias

java.lang.String get_alias(DeviceProxy deviceProxy)
                           throws DevFailed

Get alias for the device

Returns:

the alias name if found.

Throws:

DevFailed

get_info

DeviceInfo get_info(DeviceProxy deviceProxy)
                    throws DevFailed

Query the database for the info of this device.

Returns:

the information in a DeviceInfo.

Throws:

DevFailed

import_device

DbDevImportInfo import_device(DeviceProxy deviceProxy)
                              throws DevFailed

Query the database for the export info of this device.

Returns:

the information in a DbDevImportInfo.

Throws:

DevFailed

export_device

void export_device(DeviceProxy deviceProxy,
                   DbDevExportInfo devinfo)
                   throws DevFailed

Update the export info for this device in the database.

Parameters:

devinfo - Device information to export.

Throws:

DevFailed

unexport_device

void unexport_device(DeviceProxy deviceProxy)
                     throws DevFailed

Unexport the device in database.

Throws:

DevFailed

add_device

void add_device(DeviceProxy deviceProxy,
                DbDevInfo devinfo)
                throws DevFailed

Add/update this device to the database

Parameters:

devinfo - The device name, class and server specified in object.

Throws:

DevFailed

delete_device

void delete_device(DeviceProxy deviceProxy)
                   throws DevFailed

Delete this device from the database

Throws:

DevFailed

get_property_list

java.lang.String[] get_property_list(DeviceProxy deviceProxy,
                                     java.lang.String wildcard)
                                     throws DevFailed

Query the database for a list of device properties for the pecified object.

Parameters:

wildcard - propertie's wildcard (* matches any charactere).

Returns:

properties in DbDatum objects.

Throws:

DevFailed

get_property

DbDatum[] get_property(DeviceProxy deviceProxy,
                       java.lang.String[] propnames)
                       throws DevFailed

Query the database for a list of device properties for this device.

Parameters:

propnames - list of property names.

Returns:

properties in DbDatum objects.

Throws:

DevFailed

get_property

DbDatum get_property(DeviceProxy deviceProxy,
                     java.lang.String propname)
                     throws DevFailed

Query the database for a device property for this device.

Parameters:

propname - property name.

Returns:

property in DbDatum objects.

Throws:

DevFailed

get_property

DbDatum[] get_property(DeviceProxy deviceProxy,
                       DbDatum[] properties)
                       throws 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.

Returns:

properties in DbDatum objects.

Throws:

DevFailed

put_property

void put_property(DeviceProxy deviceProxy,
                  DbDatum prop)
                  throws DevFailed

Insert or update a property for this device The property name and its value are specified by the DbDatum

Parameters:

prop - Property name and value

Throws:

DevFailed

put_property

void put_property(DeviceProxy deviceProxy,
                  DbDatum[] properties)
                  throws 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.

Throws:

DevFailed

delete_property

void delete_property(DeviceProxy deviceProxy,
                     java.lang.String[] propnames)
                     throws DevFailed

Delete a list of properties for this device.

Parameters:

propnames - Property names.

Throws:

DevFailed

delete_property

void delete_property(DeviceProxy deviceProxy,
                     java.lang.String propname)
                     throws DevFailed

Delete a property for this device.

Parameters:

propname - Property name.

Throws:

DevFailed

delete_property

void delete_property(DeviceProxy deviceProxy,
                     DbDatum[] properties)
                     throws DevFailed

Delete a list of properties for this device.

Parameters:

properties - Property DbDatum objects.

Throws:

DevFailed

get_attribute_list

java.lang.String[] get_attribute_list(DeviceProxy deviceProxy)
                                      throws DevFailed

Query the device for attribute config and returns names only.

Returns:

attributes list for specified device

Throws:

DevFailed

put_attribute_property

void put_attribute_property(DeviceProxy deviceProxy,
                            DbAttribute[] attr)
                            throws DevFailed

Insert or update a list of attribute properties for this device. The property names and their values are specified by the DbAttribute array.

Parameters:

attr - attribute names and properties (names and values) array.

Throws:

DevFailed

put_attribute_property

void put_attribute_property(DeviceProxy deviceProxy,
                            DbAttribute attr)
                            throws DevFailed

Insert or update an attribute properties for this device. The property names and their values are specified by the DbAttribute array.

Parameters:

attr - attribute name and properties (names and values).

Throws:

DevFailed

delete_attribute_property

void delete_attribute_property(DeviceProxy deviceProxy,
                               java.lang.String attname,
                               java.lang.String[] propnames)
                               throws DevFailed

Delete a list of properties for this object.

Parameters:

attname - attribute name.

propnames - Property names.

Throws:

DevFailed

delete_attribute_property

void delete_attribute_property(DeviceProxy deviceProxy,
                               java.lang.String attname,
                               java.lang.String propname)
                               throws DevFailed

Delete a property for this object.

Parameters:

attname - attribute name.

propname - Property name.

Throws:

DevFailed

delete_attribute_property

void delete_attribute_property(DeviceProxy deviceProxy,
                               DbAttribute attr)
                               throws DevFailed

Delete a list of properties for this object.

Throws:

DevFailed

delete_attribute_property

void delete_attribute_property(DeviceProxy deviceProxy,
                               DbAttribute[] attr)
                               throws DevFailed

Delete a list of properties for this object.

Throws:

DevFailed

get_attribute_property

DbAttribute[] get_attribute_property(DeviceProxy deviceProxy,
                                     java.lang.String[] attnames)
                                     throws DevFailed

Query the database for a list of device attribute properties for this device.

Parameters:

attnames - list of attribute names.

Returns:

properties in DbAttribute objects array.

Throws:

DevFailed

get_attribute_property

DbAttribute get_attribute_property(DeviceProxy deviceProxy,
                                   java.lang.String attname)
                                   throws DevFailed

Query the database for a device attribute property for this device.

Parameters:

attname - attribute name.

Returns:

property in DbAttribute object.

Throws:

DevFailed

delete_attribute

void delete_attribute(DeviceProxy deviceProxy,
                      java.lang.String attname)
                      throws DevFailed

Delete an attribute for this object.

Parameters:

attname - attribute name.

Throws:

DevFailed

get_attribute_info

AttributeInfo[] get_attribute_info(DeviceProxy deviceProxy,
                                   java.lang.String[] attnames)
                                   throws DevFailed

Get the attributes configuration for the specified device.

Parameters:

attnames - attribute names to request config.

Returns:

the attributes configuration.

Throws:

DevFailed

get_attribute_info_ex

AttributeInfoEx[] get_attribute_info_ex(DeviceProxy deviceProxy,
                                        java.lang.String[] attnames)
                                        throws DevFailed

Get the extended attributes configuration for the specified device.

Parameters:

attnames - attribute names to request config.

Returns:

the attributes configuration.

Throws:

DevFailed

get_attribute_config

AttributeInfo[] get_attribute_config(DeviceProxy deviceProxy,
                                     java.lang.String[] attnames)
                                     throws DevFailed

Deprecated. use get_attribute_info(String[] attnames)

Get the attributes configuration for the specified device.

Parameters:

attnames - attribute names to request config.

Returns:

the attributes configuration.

Throws:

DevFailed

get_attribute_info

AttributeInfo get_attribute_info(DeviceProxy deviceProxy,
                                 java.lang.String attname)
                                 throws DevFailed

Get the attribute info for the specified device.

Parameters:

attname - attribute name to request config.

Returns:

the attribute info.

Throws:

DevFailed

get_attribute_info_ex

AttributeInfoEx get_attribute_info_ex(DeviceProxy deviceProxy,
                                      java.lang.String attname)
                                      throws DevFailed

Get the attribute info for the specified device.

Parameters:

attname - attribute name to request config.

Returns:

the attribute info.

Throws:

DevFailed

get_attribute_config

AttributeInfo get_attribute_config(DeviceProxy deviceProxy,
                                   java.lang.String attname)
                                   throws DevFailed

Deprecated. use get_attribute_info(String attname)

Get the attribute configuration for the specified device.

Parameters:

attname - attribute name to request config.

Returns:

the attribute configuration.

Throws:

DevFailed

get_attribute_info

AttributeInfo[] get_attribute_info(DeviceProxy deviceProxy)
                                   throws DevFailed

Get all attributes info for the specified device.

Returns:

all attributes info.

Throws:

DevFailed

get_attribute_info_ex

AttributeInfoEx[] get_attribute_info_ex(DeviceProxy deviceProxy)
                                        throws DevFailed

Get all attributes info for the specified device.

Returns:

all attributes info.

Throws:

DevFailed

get_attribute_config

AttributeInfo[] get_attribute_config(DeviceProxy deviceProxy)
                                     throws DevFailed

Deprecated. use get_attribute_info()

Get all attributes configuration for the specified device.

Returns:

all attributes configuration.

Throws:

DevFailed

set_attribute_info

void set_attribute_info(DeviceProxy deviceProxy,
                        AttributeInfo[] attr)
                        throws DevFailed

Update the attributes info for the specified device.

Parameters:

attr - the attributes info.

Throws:

DevFailed

set_attribute_info

void set_attribute_info(DeviceProxy deviceProxy,
                        AttributeInfoEx[] attr)
                        throws DevFailed

Update the attributes extended info for the specified device.

Parameters:

attr - the attributes info.

Throws:

DevFailed

set_attribute_config

void set_attribute_config(DeviceProxy deviceProxy,
                          AttributeInfo[] attr)
                          throws DevFailed

Deprecated. use set_attribute_info(AttributeInfo[] attr)

Update the attributes configuration for the specified device.

Parameters:

attr - the attributes configuration.

Throws:

DevFailed

read_attribute

DeviceAttribute read_attribute(DeviceProxy deviceProxy,
                               java.lang.String attname)
                               throws DevFailed

Read the attribute value for the specified device.

Parameters:

attname - attribute name to request value.

Returns:

the attribute value.

Throws:

DevFailed

read_attribute_value

AttributeValue read_attribute_value(DeviceProxy deviceProxy,
                                    java.lang.String attname)
                                    throws DevFailed

Throws:

DevFailed

read_attribute

DeviceAttribute[] read_attribute(DeviceProxy deviceProxy,
                                 java.lang.String[] attnames)
                                 throws DevFailed

Read the attribute values for the specified device.

Parameters:

attnames - attribute names to request values.

Returns:

the attribute values.

Throws:

DevFailed

write_attribute

void write_attribute(DeviceProxy deviceProxy,
                     DeviceAttribute devattr)
                     throws DevFailed

Write the attribute value for the specified device.

Parameters:

devattr - attribute name and value.

Throws:

DevFailed

write_attribute

void write_attribute(DeviceProxy deviceProxy,
                     DeviceAttribute[] devattr)
                     throws DevFailed

Write the attribute values for the specified device.

Parameters:

devattr - attribute names and values.

Throws:

DevFailed

write_read_attribute

DeviceAttribute[] write_read_attribute(DeviceProxy deviceProxy,
                                       DeviceAttribute[] devattr)
                                       throws DevFailed

Write and then read the attribute values, for the specified device.

Parameters:

devattr - attribute names and values.

Throws:

DevFailed

get_adm_dev

DeviceProxy get_adm_dev(DeviceProxy deviceProxy)
                        throws DevFailed

Throws:

DevFailed

poll_command

void poll_command(DeviceProxy deviceProxy,
                  java.lang.String cmdname,
                  int period)
                  throws DevFailed

Add a command to be polled for the device. If already polled, update its polling period.

Parameters:

cmdname - command name to be polled.

period - polling period.

Throws:

DevFailed

poll_attribute

void poll_attribute(DeviceProxy deviceProxy,
                    java.lang.String attname,
                    int period)
                    throws DevFailed

Add a attribute to be polled for the device. If already polled, update its polling period.

Parameters:

attname - attribute name to be polled.

period - polling period.

Throws:

DevFailed

stop_poll_command

void stop_poll_command(DeviceProxy deviceProxy,
                       java.lang.String cmdname)
                       throws DevFailed

Remove command of polled object list

Parameters:

cmdname - command name to be removed of polled object list.

Throws:

DevFailed

stop_poll_attribute

void stop_poll_attribute(DeviceProxy deviceProxy,
                         java.lang.String attname)
                         throws DevFailed

Remove attribute of polled object list

Parameters:

attname - attribute name to be removed of polled object list.

Throws:

DevFailed

polling_status

java.lang.String[] polling_status(DeviceProxy deviceProxy)
                                  throws DevFailed

Returns the polling status for the device.

Throws:

DevFailed

command_history

DeviceDataHistory[] command_history(DeviceProxy deviceProxy,
                                    java.lang.String cmdname,
                                    int nb)
                                    throws DevFailed

Return the history for command polled.

Parameters:

cmdname - command name to read polled history.

nb - nb data to read.

Throws:

DevFailed

attribute_history

DeviceDataHistory[] attribute_history(DeviceProxy deviceProxy,
                                      java.lang.String attname,
                                      int nb)
                                      throws DevFailed

Return the history for attribute polled.

Parameters:

attname - attribute name to read polled history.

nb - nb data to read.

Throws:

DevFailed

command_history

DeviceDataHistory[] command_history(DeviceProxy deviceProxy,
                                    java.lang.String cmdname)
                                    throws DevFailed

Return the full history for command polled.

Parameters:

cmdname - command name to read polled history.

Throws:

DevFailed

attribute_history

DeviceDataHistory[] attribute_history(DeviceProxy deviceProxy,
                                      java.lang.String attname)
                                      throws DevFailed

Return the full history for attribute polled.

Parameters:

attname - attribute name to read polled history.

Throws:

DevFailed

get_attribute_polling_period

int get_attribute_polling_period(DeviceProxy deviceProxy,
                                 java.lang.String attname)
                                 throws DevFailed

Returns the polling period (in ms) for specified attribute.

Parameters:

attname - specified attribute name.

Throws:

DevFailed

get_command_polling_period

int get_command_polling_period(DeviceProxy deviceProxy,
                               java.lang.String cmdname)
                               throws DevFailed

Returns the polling period (in ms) for specified command.

Parameters:

cmdname - specified attribute name.

Throws:

DevFailed

command_inout_asynch

int command_inout_asynch(DeviceProxy deviceProxy,
                         java.lang.String cmdname,
                         DeviceData data_in)
                         throws DevFailed

Asynchronous command_inout.

Parameters:

cmdname - command name.

data_in - input argument command.

Throws:

DevFailed

command_inout_asynch

int command_inout_asynch(DeviceProxy deviceProxy,
                         java.lang.String cmdname)
                         throws DevFailed

Asynchronous command_inout.

Parameters:

cmdname - command name.

Throws:

DevFailed

command_inout_asynch

int command_inout_asynch(DeviceProxy deviceProxy,
                         java.lang.String cmdname,
                         boolean forget)
                         throws DevFailed

Asynchronous command_inout.

Parameters:

cmdname - command name.

forget - forget the response if true

Throws:

DevFailed

command_inout_asynch

int command_inout_asynch(DeviceProxy deviceProxy,
                         java.lang.String cmdname,
                         DeviceData data_in,
                         boolean forget)
                         throws DevFailed

Asynchronous command_inout.

Parameters:

cmdname - command name.

data_in - input argument command.

forget - forget the response if true

Throws:

DevFailed

command_inout_asynch

void command_inout_asynch(DeviceProxy deviceProxy,
                          java.lang.String cmdname,
                          DeviceData argin,
                          CallBack cb)
                          throws DevFailed

Asynchronous command_inout using callback for reply.

Parameters:

cmdname - Command name.

argin - Input argument command.

cb - a CallBack object instance.

Throws:

DevFailed

command_inout_asynch

void command_inout_asynch(DeviceProxy deviceProxy,
                          java.lang.String cmdname,
                          CallBack cb)
                          throws DevFailed

Asynchronous command_inout using callback for reply.

Parameters:

cmdname - Command name.

cb - a CallBack object instance.

Throws:

DevFailed

command_inout_reply

DeviceData command_inout_reply(DeviceProxy deviceProxy,
                               int id,
                               int timeout)
                               throws DevFailed,
                                      AsynReplyNotArrived

Read Asynchronous command_inout reply.

Parameters:

id - asynchronous call id (returned by command_inout_asynch).

timeout - number of millisonds to wait reply before throw an excption.

Throws:

DevFailed

AsynReplyNotArrived

command_inout_reply

DeviceData command_inout_reply(DeviceProxy deviceProxy,
                               fr.esrf.TangoApi.AsyncCallObject aco,
                               int timeout)
                               throws DevFailed,
                                      AsynReplyNotArrived

Read Asynchronous command_inout reply.

Parameters:

aco - asynchronous call Request instance

timeout - number of millisonds to wait reply before throw an excption.

Throws:

DevFailed

AsynReplyNotArrived

command_inout_reply

DeviceData command_inout_reply(DeviceProxy deviceProxy,
                               int id)
                               throws DevFailed,
                                      AsynReplyNotArrived

Read Asynchronous command_inout reply.

Parameters:

id - asynchronous call id (returned by command_inout_asynch).

Throws:

DevFailed

AsynReplyNotArrived

command_inout_reply

DeviceData command_inout_reply(DeviceProxy deviceProxy,
                               fr.esrf.TangoApi.AsyncCallObject aco)
                               throws DevFailed,
                                      AsynReplyNotArrived

Read Asynchronous command_inout reply.

Parameters:

aco - asynchronous call Request instance

Throws:

DevFailed

AsynReplyNotArrived

read_attribute_asynch

int read_attribute_asynch(DeviceProxy deviceProxy,
                          java.lang.String attname)
                          throws DevFailed

Asynchronous read_attribute.

Parameters:

attname - Attribute name.

Throws:

DevFailed

read_attribute_asynch

int read_attribute_asynch(DeviceProxy deviceProxy,
                          java.lang.String[] attnames)
                          throws DevFailed

Asynchronous read_attribute.

Parameters:

attnames - Attribute names.

Throws:

DevFailed

get_asynch_idl_cmd

java.lang.String get_asynch_idl_cmd(DeviceProxy deviceProxy,
                                    org.omg.CORBA.Request request,
                                    java.lang.String idl_cmd)

Retrieve the command/attribute arguments to build exception description.

check_asynch_reply

void check_asynch_reply(DeviceProxy deviceProxy,
                        org.omg.CORBA.Request request,
                        int id,
                        java.lang.String idl_cmd)
                        throws DevFailed,
                               AsynReplyNotArrived

Check Asynchronous call reply.

Parameters:

id - asynchronous call id (returned by read_attribute_asynch).

Throws:

DevFailed

AsynReplyNotArrived

read_attribute_reply

DeviceAttribute[] read_attribute_reply(DeviceProxy deviceProxy,
                                       int id,
                                       int timeout)
                                       throws DevFailed,
                                              AsynReplyNotArrived

Read Asynchronous read_attribute reply.

Parameters:

id - asynchronous call id (returned by read_attribute_asynch).

timeout - number of millisonds to wait reply before throw an excption.

Throws:

DevFailed

AsynReplyNotArrived

read_attribute_reply

DeviceAttribute[] read_attribute_reply(DeviceProxy deviceProxy,
                                       int id)
                                       throws DevFailed,
                                              AsynReplyNotArrived

Read Asynchronous read_attribute reply.

Parameters:

id - asynchronous call id (returned by read_attribute_asynch).

Throws:

DevFailed

AsynReplyNotArrived

read_attribute_asynch

void read_attribute_asynch(DeviceProxy deviceProxy,
                           java.lang.String attname,
                           CallBack cb)
                           throws DevFailed

Asynchronous read_attribute using callback for reply.

Parameters:

attname - attribute name.

cb - a CallBack object instance.

Throws:

DevFailed

read_attribute_asynch

void read_attribute_asynch(DeviceProxy deviceProxy,
                           java.lang.String[] attnames,
                           CallBack cb)
                           throws DevFailed

Asynchronous read_attribute using callback for reply.

Parameters:

attnames - attribute names.

cb - a CallBack object instance.

Throws:

DevFailed

write_attribute_asynch

int write_attribute_asynch(DeviceProxy deviceProxy,
                           DeviceAttribute attr)
                           throws DevFailed

Asynchronous write_attribute.

Parameters:

attr - Attribute value (name, writing value...)

Throws:

DevFailed

write_attribute_asynch

int write_attribute_asynch(DeviceProxy deviceProxy,
                           DeviceAttribute attr,
                           boolean forget)
                           throws DevFailed

Asynchronous write_attribute.

Parameters:

attr - Attribute value (name, writing value...)

forget - forget the response if true

Throws:

DevFailed

write_attribute_asynch

int write_attribute_asynch(DeviceProxy deviceProxy,
                           DeviceAttribute[] attribs)
                           throws DevFailed

Asynchronous write_attribute.

Parameters:

attribs - Attribute values (name, writing value...)

Throws:

DevFailed

write_attribute_asynch

int write_attribute_asynch(DeviceProxy deviceProxy,
                           DeviceAttribute[] attribs,
                           boolean forget)
                           throws DevFailed

Asynchronous write_attribute.

Parameters:

attribs - Attribute values (name, writing value...)

forget - forget the response if true

Throws:

DevFailed

write_attribute_reply

void write_attribute_reply(DeviceProxy deviceProxy,
                           int id)
                           throws DevFailed,
                                  AsynReplyNotArrived

check for Asynchronous write_attribute reply.

Parameters:

id - asynchronous call id (returned by read_attribute_asynch).

Throws:

DevFailed

AsynReplyNotArrived

write_attribute_reply

void write_attribute_reply(DeviceProxy deviceProxy,
                           int id,
                           int timeout)
                           throws DevFailed,
                                  AsynReplyNotArrived

check for Asynchronous write_attribute reply.

Parameters:

id - asynchronous call id (returned by write_attribute_asynch).

timeout - number of millisonds to wait reply before throw an excption.

Throws:

DevFailed

AsynReplyNotArrived

write_attribute_asynch

void write_attribute_asynch(DeviceProxy deviceProxy,
                            DeviceAttribute attr,
                            CallBack cb)
                            throws DevFailed

Asynchronous write_attribute using callback for reply.

Parameters:

attr - Attribute values (name, writing value...)

cb - a CallBack object instance.

Throws:

DevFailed

write_attribute_asynch

void write_attribute_asynch(DeviceProxy deviceProxy,
                            DeviceAttribute[] attribs,
                            CallBack cb)
                            throws DevFailed

Asynchronous write_attribute using callback for reply.

Parameters:

attribs - Attribute values (name, writing value...)

cb - a CallBack object instance.

Throws:

DevFailed

pending_asynch_call

int pending_asynch_call(DeviceProxy deviceProxy,
                        int reply_model)

return the still pending asynchronous call for a reply model.

Parameters:

reply_model - ApiDefs.ALL_ASYNCH, POLLING or CALLBACK.

get_asynch_replies

void get_asynch_replies(DeviceProxy deviceProxy)

Fire callback methods for all asynchronous requests(cmd and attr) with already arrived replies.

get_asynch_replies

void get_asynch_replies(DeviceProxy deviceProxy,
                        int timeout)

Fire callback methods for all asynchronous requests(cmd and attr) with already arrived replies.

add_logging_target

void add_logging_target(DeviceProxy deviceProxy,
                        java.lang.String target)
                        throws DevFailed

Adds a new logging target to the device.

Parameters:

target - The target for logging (e.g. file::/tmp/logging_device).

Throws:

DevFailed

remove_logging_target

void remove_logging_target(DeviceProxy deviceProxy,
                           java.lang.String target_type,
                           java.lang.String target_name)
                           throws DevFailed

Removes a new logging target to the device.

Throws:

DevFailed

get_logging_target

java.lang.String[] get_logging_target(DeviceProxy deviceProxy)
                                      throws DevFailed

get logging target from the device.

Throws:

DevFailed

get_logging_level

int get_logging_level(DeviceProxy deviceProxy)
                      throws DevFailed

get logging level from the device.

Returns:

device's logging level: (ApiDefs.LOGGING_OFF, ApiDefs.LOGGING_FATAL, ApiDefs.LOGGING_ERROR, ApiDefs.LOGGING_INFO, ApiDefs.LOGGING_DEBUG)

Throws:

DevFailed

set_logging_level

void set_logging_level(DeviceProxy deviceProxy,
                       int level)
                       throws DevFailed

Set logging level from the device.

Parameters:

level - device's logging level: (ApiDefs.LOGGING_OFF, ApiDefs.LOGGING_FATAL, ApiDefs.LOGGING_ERROR, ApiDefs.LOGGING_INFO, ApiDefs.LOGGING_DEBUG)

Throws:

DevFailed

lock

void lock(DeviceProxy deviceProxy,
          int validity)
          throws DevFailed

Lock the device

Parameters:

validity - Lock validity (in seconds)

Throws:

DevFailed

unlock

int unlock(DeviceProxy deviceProxy)
           throws DevFailed

Unlock the device

Returns:

the device lock counter

Throws:

DevFailed

isLocked

boolean isLocked(DeviceProxy deviceProxy)
                 throws DevFailed

Returns true if the device is locked

Throws:

DevFailed

isLockedByMe

boolean isLockedByMe(DeviceProxy deviceProxy)
                     throws DevFailed

Returns true if the device is locked by this process

Throws:

DevFailed

getLockerStatus

java.lang.String getLockerStatus(DeviceProxy deviceProxy)
                                 throws DevFailed

Returns the device lock status

Throws:

DevFailed

getLockerInfo

LockerInfo getLockerInfo(DeviceProxy deviceProxy)
                         throws DevFailed

Returns the device lock info

Throws:

DevFailed

dev_inform

java.lang.String[] dev_inform(DeviceProxy deviceProxy)
                              throws DevFailed

Returns TACO device information.

Returns:

TACO device information as String array.

Device name.

Class name

Device type

Device server name

Host name

Throws:

DevFailed

set_rpc_protocol

void set_rpc_protocol(DeviceProxy deviceProxy,
                      int mode)
                      throws DevFailed

Execute the dev_rpc_protocol TACO command to change RPC protocol mode.

Parameters:

mode - RPC protocol mode to be seted (TangoApi.TacoDevice.D_TCP or TangoApi.TacoDevice.D_UDP).

Throws:

DevFailed

get_rpc_protocol

int get_rpc_protocol(DeviceProxy deviceProxy)
                     throws DevFailed

Returns:

mode RPC protocol mode used

Throws:

DevFailed

main

void main(java.lang.String[] args)

Just a main method to check API methods.

subscribe_event

int subscribe_event(DeviceProxy deviceProxy,
                    java.lang.String attr_name,
                    int event,
                    CallBack callback,
                    java.lang.String[] filters,
                    boolean stateless)
                    throws DevFailed

Subscribe to an event.

Parameters:

attr_name - attribute name.

event - event name.

callback - event callback.

stateless - If true, do not throw exception if connection failed.

Throws:

DevFailed

subscribe_event

int subscribe_event(DeviceProxy deviceProxy,
                    java.lang.String attr_name,
                    int event,
                    int max_size,
                    java.lang.String[] filters,
                    boolean stateless)
                    throws DevFailed

Subscribe to event to be stored in an event queue.

Parameters:

attr_name - attribute name.

event - event name.

max_size - event queue maximum size.

stateless - If true, do not throw exception if connection failed.

Throws:

DevFailed

unsubscribe_event

void unsubscribe_event(DeviceProxy deviceProxy,
                       int event_id)
                       throws DevFailed

Unsubscribe to an event.

Parameters:

event_id - event identifier.

Throws:

DevFailed