fr.esrf.TangoApi
Interface IApiUtilDAO

All Known Implementing Classes:

ApiUtilDAODefaultImpl

public interface IApiUtilDAO

Method Summary

Database	change_db_obj(java.lang.String host, java.lang.String port) Return the database object created for specified host and port, and set this database object for all following uses..
void	create_event_consumer() Create the event consumer.
fr.esrf.TangoApi.AsyncCallObject	get_async_object(int id) Return the Asynch Object in hash table for the id
org.omg.CORBA.Request	get_async_request(int id) Return the request in hash table for the id
int	get_asynch_cb_sub_model() Set the callback sub model used (ApiDefs.PUSH_CALLBACK or ApiDefs.PULL_CALLBACK).
void	get_asynch_replies() Fire callback methods for all (any device) asynchronous requests(cmd and attr) with already arrived replies.
void	get_asynch_replies(DeviceProxy dev) Fire callback methods for all (any device) asynchronous requests(cmd and attr) with already arrived replies.
void	get_asynch_replies(DeviceProxy dev, int timeout) Fire callback methods for all (any device) asynchronous requests(cmd and attr) with already arrived replies.
void	get_asynch_replies(int timeout) Fire callback methods for all (any device) asynchronous requests(cmd and attr) with already arrived replies.
Database	get_db_obj() Return the database object created with TANGO_HOST environment variable .
Database	get_db_obj(java.lang.String tango_host) Return the database object created for specified host and port.
Database	get_db_obj(java.lang.String host, java.lang.String port) Return the database object created for specified host and port.
Database	get_default_db_obj() Return the database object created with TANGO_HOST environment variable .
IEventConsumer	get_event_consumer() Get the event consumer singleton object.
org.omg.CORBA.ORB	get_orb() Return the orb object
int	getReconnectionDelay() Return reconnection delay for controle system.
boolean	in_server() Return true if in server code or false if in client code.
java.lang.String[]	parseTangoHost(java.lang.String tgh) Parse Tango host (check multi Tango_host)
int	pending_asynch_call(DeviceProxy dev, int reply_model) return the still pending asynchronous call for a reply model.
int	pending_asynch_call(int reply_model) return the still pending asynchronous call for a reply model.
int	put_async_request(fr.esrf.TangoApi.AsyncCallObject aco) Add request in hash table and return id
java.lang.String	qualityName(AttrQuality att_q)
java.lang.String	qualityName(short att_q_val)
void	remove_async_request(int id) Remove asynchronous call request and id from hashtable.
void	set_async_reply_cb(int id, CallBack cb) Set the Callback object in AsyncCallObject for the id key.
void	set_async_reply_model(int id, int reply_model) Set the reply_model in AsyncCallObject for the id key.
void	set_asynch_cb_sub_model(int model) Return the callback sub model used.
Database	set_db_obj(java.lang.String tango_host) Return the database object created for specified host and port.
Database	set_db_obj(java.lang.String host, java.lang.String port) Return the database object created for specified host and port, and set this database object for all following uses..
void	set_in_server(boolean val) Return the orb object
java.lang.String	stateName(DevState state)
java.lang.String	stateName(short state_val)
DbAttribute[]	toDbAttributeArray(java.lang.String[] array, int mode) Convert a StringArray to a DbAttribute class array
java.lang.String[]	toStringArray(java.lang.String argin) Convert arguments to one String array
java.lang.String[]	toStringArray(java.lang.String objname, DbAttribute[] attr, int mode) Convert a DbAttribute class array to a StringArray.
java.lang.String[]	toStringArray(java.lang.String objname, java.lang.String argin) Convert arguments to one String array
java.lang.String[]	toStringArray(java.lang.String objname, java.lang.String[] argin) Convert arguments to one String array

Method Detail

get_db_obj

Database get_db_obj(java.lang.String tango_host)
                    throws DevFailed

Return the database object created for specified host and port.

Parameters:

tango_host - host and port (hostname:portnumber) where database is running.

Throws:

DevFailed

get_default_db_obj

Database get_default_db_obj()
                            throws DevFailed

Return the database object created with TANGO_HOST environment variable .

Throws:

DevFailed

get_db_obj

Database get_db_obj()
                    throws DevFailed

Return the database object created with TANGO_HOST environment variable .

Throws:

DevFailed

get_db_obj

Database get_db_obj(java.lang.String host,
                    java.lang.String port)
                    throws DevFailed

Return the database object created for specified host and port.

Parameters:

host - host where database is running.

port - port for database connection.

Throws:

DevFailed

change_db_obj

Database change_db_obj(java.lang.String host,
                       java.lang.String port)
                       throws DevFailed

Return the database object created for specified host and port, and set this database object for all following uses..

Parameters:

host - host where database is running.

port - port for database connection.

Throws:

DevFailed

set_db_obj

Database set_db_obj(java.lang.String host,
                    java.lang.String port)
                    throws DevFailed

Return the database object created for specified host and port, and set this database object for all following uses..

Parameters:

host - host where database is running.

port - port for database connection.

Throws:

DevFailed

set_db_obj

Database set_db_obj(java.lang.String tango_host)
                    throws DevFailed

Return the database object created for specified host and port.

Parameters:

tango_host - host and port (hostname:portnumber) where database is running.

Throws:

DevFailed

get_orb

org.omg.CORBA.ORB get_orb()
                          throws DevFailed

Return the orb object

Throws:

DevFailed

set_in_server

void set_in_server(boolean val)

Return the orb object

in_server

boolean in_server()

Return true if in server code or false if in client code.

getReconnectionDelay

int getReconnectionDelay()

Return reconnection delay for controle system.

put_async_request

int put_async_request(fr.esrf.TangoApi.AsyncCallObject aco)

Add request in hash table and return id

get_async_request

org.omg.CORBA.Request get_async_request(int id)
                                        throws DevFailed

Return the request in hash table for the id

Throws:

DevFailed

get_async_object

fr.esrf.TangoApi.AsyncCallObject get_async_object(int id)

Return the Asynch Object in hash table for the id

remove_async_request

void remove_async_request(int id)

Remove asynchronous call request and id from hashtable.

set_async_reply_model

void set_async_reply_model(int id,
                           int reply_model)

Set the reply_model in AsyncCallObject for the id key.

set_async_reply_cb

void set_async_reply_cb(int id,
                        CallBack cb)

Set the Callback object in AsyncCallObject for the id key.

pending_asynch_call

int pending_asynch_call(DeviceProxy dev,
                        int reply_model)

return the still pending asynchronous call for a reply model.

Parameters:

dev - DeviceProxy object.

reply_model - ApiDefs.ALL_ASYNCH, POLLING or CALLBACK.

pending_asynch_call

int pending_asynch_call(int reply_model)

return the still pending asynchronous call for a reply model.

Parameters:

reply_model - ApiDefs.ALL_ASYNCH, POLLING or CALLBACK.

set_asynch_cb_sub_model

void set_asynch_cb_sub_model(int model)

Return the callback sub model used.

Parameters:

model - ApiDefs.PUSH_CALLBACK or ApiDefs.PULL_CALLBACK.

get_asynch_cb_sub_model

int get_asynch_cb_sub_model()

Set the callback sub model used (ApiDefs.PUSH_CALLBACK or ApiDefs.PULL_CALLBACK).

get_asynch_replies

void get_asynch_replies()

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

get_asynch_replies

void get_asynch_replies(int timeout)

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

get_asynch_replies

void get_asynch_replies(DeviceProxy dev)

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

get_asynch_replies

void get_asynch_replies(DeviceProxy dev,
                        int timeout)

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

toStringArray

java.lang.String[] toStringArray(java.lang.String objname,
                                 java.lang.String[] argin)

Convert arguments to one String array

toStringArray

java.lang.String[] toStringArray(java.lang.String objname,
                                 java.lang.String argin)

Convert arguments to one String array

toStringArray

java.lang.String[] toStringArray(java.lang.String argin)

Convert arguments to one String array

toStringArray

java.lang.String[] toStringArray(java.lang.String objname,
                                 DbAttribute[] attr,
                                 int mode)

Convert a DbAttribute class array to a StringArray.

Parameters:

objname - object name (used in first index of output array)..

attr - DbAttribute array to be converted

Returns:

the String array created from input argument.

toDbAttributeArray

DbAttribute[] toDbAttributeArray(java.lang.String[] array,
                                 int mode)
                                 throws DevFailed

Convert a StringArray to a DbAttribute class array

Parameters:

array - String array to be converted

mode - decode argout params mode (mode=2 added 26/10/04)

Returns:

the DbAtribute class array created from input argument.

Throws:

DevFailed

stateName

java.lang.String stateName(DevState state)

stateName

java.lang.String stateName(short state_val)

qualityName

java.lang.String qualityName(AttrQuality att_q)

qualityName

java.lang.String qualityName(short att_q_val)

parseTangoHost

java.lang.String[] parseTangoHost(java.lang.String tgh)
                                  throws DevFailed

Parse Tango host (check multi Tango_host)

Throws:

DevFailed

create_event_consumer

void create_event_consumer()
                           throws DevFailed

Create the event consumer. This will automatically start a new thread which is waiting indefinitely for events.

Throws:

DevFailed

get_event_consumer

IEventConsumer get_event_consumer()

Get the event consumer singleton object.

Returns:

EventConsumer