Interface Tango::Device

interface Device

The fundamental interface for all TANGO objects. Each Device is a network object which can be accessed locally or via network. The network protocol on the wire will be IIOP. The Device interface implements all the basic functions needed for doing generic synchronous and asynchronous I/O on a device. A Device object has data and actions. Data are represented in the form of Attributes. Actions are represented in the form of Commands. The CORBA Device interface offers attributes and methods to access the attributes and commands. A client will either use these methods directly from C++ or Java or access them via a wrapper class. The Device interface describes only the remote network interface. Implementation features like threads, command security, priority etc. are dealt with in server side of the device server model.

THIS IS A PSEUDO-IDL FILE DOCUMENTATION



Attribute Index

access
access (readonly) - client permission on device
adm_name
adm_name (readonly) - administrator device unique ascii identifier
description
description (readonly) - general description of device
name
name (readonly) - unique ascii identifier
protocol
protocol - protocol to use between client and device
source
source (readwrite) - source of device data (locality constrained)
state
state (readonly) - device state
status
status (readonly) - device state as ascii string
timeout
timeout (readwrite) - maximum time to wait for a request to be executed before attributeling an error

Operation Index

black_box
read list of last N commands executed by clients
command_inout
execute a command on a device synchronously with no input parameter and one output parameter
command_inout_async
execute a command on a device asynchronously with one input parameter and one output parameter, callback is triggered on completion
command_list_query
query device to see what commands it supports
command_query
query device to see command argument
get_attribute_config
read the configuration for a variable list of attributes from a device
info
return general information about object e.g.
ping
ping a device to see if it alive
priority
change the client's priority on a device
read_attributes
read a variable list of attributes from a device
set_access
change the client's security key on a device
set_attribute_config
set the configuration for a variable list of attributes from the device
write_attributes
write a variable list of attributes to a device

Attributes

access
readonly attribute DevSecurity access;

access (readonly) - client permission on device


adm_name
readonly attribute string adm_name;

adm_name (readonly) - administrator device unique ascii identifier


description
readonly attribute string description;

description (readonly) - general description of device


name
readonly attribute string name;

name (readonly) - unique ascii identifier


protocol
attribute DevProtocol protocol;

protocol - protocol to use between client and device


source
attribute DevSource source;

source (readwrite) - source of device data (locality constrained)


state
readonly attribute DevState state;

state (readonly) - device state


status
readonly attribute string status;

status (readonly) - device state as ascii string


timeout
attribute TimeVal timeout;

timeout (readwrite) - maximum time to wait for a request to be executed before attributeling an error



Operations

black_box
DevVarStringArray black_box(in long n)
    raises(DevFailed);

read list of last N commands executed by clients

Parameters:
number -of commands to return
Returns:
list of command and clients

command_inout
any command_inout(in string command,
                  in any argin)
    raises(DevFailed);

execute a command on a device synchronously with no input parameter and one output parameter

Parameters:
command -ascii string e.g. "On"
argin -command input parameter e.g. float
Returns:
command result.

command_inout_async
oneway void command_inout_async(in string command,
                                in any argin,
                                in any user_data,
                                in CallBack cb);

execute a command on a device asynchronously with one input parameter and one output parameter, callback is triggered on completion

Parameters:
command -ascii string e.g. "On"
argin -command parameter
user_data -passed to callback e.g. short
callback -to be called on completion
Returns:
command result.

command_list_query
DevCmdInfoList command_list_query()
    raises(DevFailed);

query device to see what commands it supports

Returns:
list of commands and their types

command_query
DevCmdInfo command_query(in string command)
    raises(DevFailed);

query device to see command argument

Parameters:
command -name
Returns:
command and its types

get_attribute_config
AttributeConfigList get_attribute_config(in DevVarStringArray names)
    raises(DevFailed);

read the configuration for a variable list of attributes from a device

Parameters:
name -list of attribute names to read
Returns:
list of attribute configurations read

info
DevInfo info()
    raises(DevFailed);

return general information about object e.g. class, type, ...

Returns:
device info

ping
TimeVal ping()
    raises(DevFailed);

ping a device to see if it alive

Returns:
time to execute ping

priority
long priority(in long priority)
    raises(DevFailed);

change the client's priority on a device

Parameters:
priority -new priority
Returns:
new priority

read_attributes
AttributeValueList read_attributes(in DevVarStringArray names)
    raises(DevFailed);

read a variable list of attributes from a device

Parameters:
name -list of attribute names to read
Returns:
list of attribute values read

set_access
DevSecurity set_access(in DevSecurity key)
    raises(DevFailed);

change the client's security key on a device

Parameters:
key -new security key
Returns:
security key.

set_attribute_config
void set_attribute_config(in AttributeConfigList new_conf)
    raises(DevFailed);

set the configuration for a variable list of attributes from the device

Parameters:
new_conf -list of attribute configuration to be set
Returns:
nothing

write_attributes
void write_attributes(in AttributeValueList values)
    raises(DevFailed);

write a variable list of attributes to a device

Parameters:
values -list of attribute values to write
Returns:
nothing


Generated by the ORBacus IDL-to-HTML translator