|
TANGO Java API ( TangORB-7.3.3.jar) |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.omg.PortableServer.Servant
fr.esrf.Tango.Device_2POA
fr.esrf.TangoDs.DeviceImpl
public abstract class DeviceImpl
Base class for all TANGO device
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
DeviceImpl(DeviceClass cl,
java.lang.String d_name)
Constructs a newly allocated DeviceImpl object from its name. |
|
DeviceImpl(DeviceClass cl,
java.lang.String d_name,
java.lang.String desc)
Constructs a newly allocated DeviceImpl object from its name and its description. |
|
DeviceImpl(DeviceClass cl,
java.lang.String d_name,
java.lang.String de,
DevState st,
java.lang.String sta)
Constructs a newly allocated DeviceImpl object from all its creation parameters. |
|
| Method Summary | |
|---|---|
org.omg.PortableServer.POA |
_default_POA()
Return device POA Return a reference to the device POA. |
void |
add_attribute(Attr new_attr)
Add a new attribute to the device attribute list. |
java.lang.String |
adm_name()
Get administration device name. |
void |
always_executed_hook()
Hook method. |
java.lang.String[] |
black_box(int n)
Get device black box. |
org.omg.CORBA.Any |
command_inout_2(java.lang.String in_cmd,
org.omg.CORBA.Any in_data,
DevSource source)
|
DevCmdHistory[] |
command_inout_history_2(java.lang.String command,
int n)
|
org.omg.CORBA.Any |
command_inout(java.lang.String in_cmd,
org.omg.CORBA.Any in_any)
Execute a command. |
DevCmdInfo_2[] |
command_list_query_2()
Get device command list. |
DevCmdInfo[] |
command_list_query()
Get device command list. |
DevCmdInfo_2 |
command_query_2(java.lang.String command)
Get device command list. |
DevCmdInfo |
command_query(java.lang.String command)
Get command info. |
abstract void |
delete_device()
This method is called during device Init an the DevRestart command. |
java.lang.String |
description()
Get device description. |
DevState |
dev_state()
Get device state. |
java.lang.String |
dev_status()
Get device status. |
AttributeConfig_2[] |
get_attribute_config_2(java.lang.String[] names)
|
AttributeConfig[] |
get_attribute_config(java.lang.String[] names)
Get attribute(s) configuration. |
DbDevice |
get_db_device()
Get the reference to the associated DbDevice object Return the DbDevice object reference |
DeviceClass |
get_device_class()
Get device class object reference. |
org.apache.log4j.Logger |
get_logger()
Returns the device's logger |
java.lang.String |
get_name()
Get device name. |
byte[] |
get_obj_id()
Get the associated CORBA object identifier |
DevState |
get_state()
Get device state. |
java.lang.String |
get_status()
Get device status. |
DevInfo |
info()
Get device info. |
abstract void |
init_device()
Intialise a device. |
void |
init_logger()
Initialize the logging for this device |
java.lang.String |
name()
Get device name. |
void |
ping()
Ping the device to check if it is still alive. |
void |
read_attr_hardware(java.util.Vector attr_list)
Read the hardware to return attribute value(s). |
void |
read_attr(Attribute attr)
Set the attribute read value. |
DevAttrHistory[] |
read_attribute_history_2(java.lang.String name,
int n)
|
AttributeValue[] |
read_attributes_2(java.lang.String[] names,
DevSource source)
Read attribute(s) value. |
AttributeValue[] |
read_attributes(java.lang.String[] names)
Read attribute(s) value. |
void |
remove_attribute(java.lang.String attname)
Remove an attribute on the device attribute list. |
void |
set_attribute_config(AttributeConfig[] new_conf)
Set attribute(s) configuration. |
void |
set_device_attr(MultiAttribute new_multi_attr)
Set device state. |
void |
set_obj_id(byte[] id)
Set the associated CORBA object identifier |
void |
set_poll_ring_depth(int size)
|
void |
set_polled_attr(java.lang.String[] s)
|
void |
set_polled_cmd(java.lang.String[] s)
|
void |
set_state(DevState new_state)
Set device state. |
void |
set_status(java.lang.String new_status)
Set device status. |
void |
start_logging()
Restore logging level to its backup value |
DevState |
state()
Get device state. |
java.lang.String |
status()
Get device status. |
void |
stop_logging()
Backup current logging level then set it to OFF |
void |
write_attr_hardware(java.util.Vector attr_list)
Write the hardware for attributes. |
void |
write_attributes(AttributeValue[] values)
Write attribute(s). |
| Methods inherited from class fr.esrf.Tango.Device_2POA |
|---|
_all_interfaces, _invoke, _this, _this |
| Methods inherited from class org.omg.PortableServer.Servant |
|---|
_get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DeviceImpl(DeviceClass cl,
java.lang.String d_name,
java.lang.String de,
DevState st,
java.lang.String sta)
throws DevFailed
cl - Reference to the device class objectd_name - The device namede - The device description fieldst - The device creation statesta - The device creation status
DevFailed - Re-throw of the exception thrown during the creation of
the multi-attribute object. Click here to read DevFailed exception specification
public DeviceImpl(DeviceClass cl,
java.lang.String d_name)
throws DevFailed
cl - Reference to the device class objectd_name - The device name
DevFailed - Re-throw of the exception thrown during the creation of
the multi-attribute object. Click here to read DevFailed exception specification
public DeviceImpl(DeviceClass cl,
java.lang.String d_name,
java.lang.String desc)
throws DevFailed
cl - Reference to the device class objectd_name - The device namedesc - The device description
DevFailed - Re-throw of the exception thrown during the creation of
the multi-attribute object. Click here to read DevFailed exception specification| Method Detail |
|---|
public org.omg.CORBA.Any command_inout(java.lang.String in_cmd,
org.omg.CORBA.Any in_any)
throws DevFailed
command_inout in interface DeviceOperationsin_cmd - The command namein_any - The command input data packed in a CORBA Any
DevFailed - Re-throw of the exception thrown by the command_handler
method. Click here to read DevFailed exception specification
public org.omg.CORBA.Any command_inout_2(java.lang.String in_cmd,
org.omg.CORBA.Any in_data,
DevSource source)
throws DevFailed,
org.omg.CORBA.SystemException
command_inout_2 in interface Device_2OperationsDevFailed
org.omg.CORBA.SystemException
public DevCmdHistory[] command_inout_history_2(java.lang.String command,
int n)
throws DevFailed,
org.omg.CORBA.SystemException
command_inout_history_2 in interface Device_2OperationsDevFailed
org.omg.CORBA.SystemExceptionpublic java.lang.String name()
name in interface DeviceOperationspublic java.lang.String adm_name()
adm_name in interface DeviceOperationspublic java.lang.String description()
description in interface DeviceOperationspublic DevState state()
state in interface DeviceOperationspublic java.lang.String status()
status in interface DeviceOperations
public java.lang.String[] black_box(int n)
throws DevFailed
black_box in interface DeviceOperationsn - The number of actions description which must be returned to
the client. The number of returned element is limited to the
number of elements stored in the black-box or to the complete
black-box depth if it is full.
DevFailed - If it is not possible to read the device black box. Click
here
to read DevFailed exception specificationpublic DevCmdInfo[] command_list_query()
command_list_query in interface DeviceOperationspublic DevCmdInfo_2[] command_list_query_2()
command_list_query_2 in interface Device_2Operations
public DevCmdInfo_2 command_query_2(java.lang.String command)
throws DevFailed,
org.omg.CORBA.SystemException
command_query_2 in interface Device_2Operationscommand - The specified command name.
DevFailed
org.omg.CORBA.SystemException
public DevCmdInfo command_query(java.lang.String command)
throws DevFailed
command_query in interface DeviceOperationscommand - The command name
DevFailed - Thrown if the command does not exist. Click here to read DevFailed exception specificationpublic DevInfo info()
info in interface DeviceOperationspublic void ping()
ping in interface DeviceOperations
public AttributeConfig[] get_attribute_config(java.lang.String[] names)
throws DevFailed
get_attribute_config in interface DeviceOperationsnames - The attribute name list
DevFailed - Thrown if one of the attribute does not exist. Click here
to read DevFailed exception specification
public AttributeConfig_2[] get_attribute_config_2(java.lang.String[] names)
throws DevFailed,
org.omg.CORBA.SystemException
get_attribute_config_2 in interface Device_2OperationsDevFailed
org.omg.CORBA.SystemException
public void set_attribute_config(AttributeConfig[] new_conf)
throws DevFailed
set_attribute_config in interface DeviceOperationsnew_conf - The attribute(s) new configuration list. There is one
AttributeConfig object for each attribute with configuration
to be updated
DevFailed - Thrown if one of the attribute does not exist. Click here
to read DevFailed exception specification
public AttributeValue[] read_attributes(java.lang.String[] names)
throws DevFailed
read_attributes in interface DeviceOperationsnames - The attribute name list
DevFailed - Thrown if one of the attribute does not exist or if a
problem occurs during attribute reading. Click here to read DevFailed exception specification
public AttributeValue[] read_attributes_2(java.lang.String[] names,
DevSource source)
throws DevFailed
read_attributes_2 in interface Device_2Operationsnames - The attribute name listsource - could be DevSource.CACHE, DevSource.CACHE_DEV or
DevSource.DEVICE.
DevFailed - Thrown if one of the attribute does not exist or if a
problem occurs during attribute reading. Click here to read DevFailed exception specification
public DevAttrHistory[] read_attribute_history_2(java.lang.String name,
int n)
throws DevFailed,
org.omg.CORBA.SystemException
read_attribute_history_2 in interface Device_2OperationsDevFailed
org.omg.CORBA.SystemException
public void write_attributes(AttributeValue[] values)
throws DevFailed
write_attributes in interface DeviceOperationsvalues - The attribute(s) new set value. There is one AttributeValue
object for each attribute to be set
DevFailed - Thrown if one of the attribute does not exist. Click here
to read DevFailed exception specification
public void remove_attribute(java.lang.String attname)
throws DevFailed
attname - Attribute's name to be removed to the list
DevFailed - .
public void add_attribute(Attr new_attr)
throws DevFailed
new_attr - Reference to the new attribute to be added to the list
DevFailed - . Click
here
to read DevFailed exception specification
public DevState dev_state()
throws DevFailed
DevFailed - If it is necessary to read attribute(s) and a problem
occurs during the reading. Click here to read DevFailed exception specification
public java.lang.String dev_status()
throws DevFailed
DevFailed - This method does not throw exception but a redefined
method can. Click here to read DevFailed exception specification
public void read_attr_hardware(java.util.Vector attr_list)
throws DevFailed
attr_list - Reference to a vector with Integer object. Each element in
this vector is the index in the device onject attribute vector
of an attribute to be read.
DevFailed - This method does not throw exception but a redefined
method can. Click here to read DevFailed exception specification
public void read_attr(Attribute attr)
throws DevFailed
attr - The attribute object
DevFailed - This method does not throw exception but a redefined
method can. Click here to read DevFailed exception specification
public void write_attr_hardware(java.util.Vector attr_list)
throws DevFailed
attr_list - Reference to a vector of Integer objects. Each element in this
vector is the index in the main attribute vector of an
attribute to be written.
DevFailed - This method does not throw exception but a redefined
method can. Click here to read DevFailed exception specification
public void always_executed_hook()
throws DevFailed
DevFailed - This method does not throw exception but a redefined
method can. Click here to read DevFailed exception specification
public abstract void init_device()
throws DevFailed
DevFailed - This method does not throw exception but a redefined
method can. Click here to read DevFailed exception specification
public abstract void delete_device()
throws DevFailed
DevFailedpublic org.omg.PortableServer.POA _default_POA()
_default_POA in class org.omg.PortableServer.Servantpublic java.lang.String get_status()
public void set_status(java.lang.String new_status)
new_status - The new device statuspublic DevState get_state()
public void set_state(DevState new_state)
new_state - The new device statepublic java.lang.String get_name()
public DeviceClass get_device_class()
public void set_device_attr(MultiAttribute new_multi_attr)
new_multi_attr - The new attributepublic DbDevice get_db_device()
public byte[] get_obj_id()
public void set_obj_id(byte[] id)
id - The CORBA object identifierpublic org.apache.log4j.Logger get_logger()
public void init_logger()
public void stop_logging()
public void start_logging()
public void set_poll_ring_depth(int size)
public void set_polled_cmd(java.lang.String[] s)
public void set_polled_attr(java.lang.String[] s)
|
TANGO Java API ( TangORB-7.3.3.jar) |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||