/usr/share/pyshared/PyTango/device_proxy.py is in python-pytango 7.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 | ################################################################################
##
## This file is part of PyTango, a python binding for Tango
##
## http://www.tango-controls.org/static/PyTango/latest/doc/html/index.html
##
## Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
## PyTango is free software: you can redistribute it and/or modify
## it under the terms of the GNU Lesser General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## PyTango is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU Lesser General Public License for more details.
##
## You should have received a copy of the GNU Lesser General Public License
## along with PyTango. If not, see <http://www.gnu.org/licenses/>.
##
################################################################################
"""
This is an internal PyTango module.
"""
from __future__ import with_statement
__all__ = []
__docformat__ = "restructuredtext"
import operator
import types
import threading
from _PyTango import StdStringVector
from _PyTango import DbData, DbDatum
from _PyTango import AttributeInfo, AttributeInfoEx
from _PyTango import AttributeInfoList, AttributeInfoListEx
from _PyTango import DeviceProxy
from _PyTango import __CallBackAutoDie, __CallBackPushEvent, EventType
from _PyTango import DevFailed, Except
from _PyTango import ExtractAs
from PyTango.utils import seq_2_StdStringVector, StdStringVector_2_seq
from PyTango.utils import seq_2_DbData, DbData_2_dict
from utils import document_method as __document_method
#-------------------------------------------------------------------------------
# Pythonic API: transform tango commands into methods and tango attributes into
# class members
#-------------------------------------------------------------------------------
def __check_read_attribute(dev_attr):
if dev_attr.has_failed:
raise DevFailed(*dev_attr.get_err_stack())
return dev_attr
def __DeviceProxy__refresh_cmd_cache(self):
cmd_list = self.command_list_query()
cmd_cache = {}
for cmd in cmd_list:
n = cmd.cmd_name.lower()
cmd_cache[n] = cmd, None
self.__dict__['__cmd_cache'] = cmd_cache
def __DeviceProxy__refresh_attr_cache(self):
attr_cache = [attr_name.lower() for attr_name in self.get_attribute_list()]
self.__dict__['__attr_cache'] = attr_cache
def __DeviceProxy__getattr(self, name):
# trait_names is a feature of IPython. Hopefully they will solve
# ticket http://ipython.scipy.org/ipython/ipython/ticket/229 someday
# and the ugly trait_names could be removed.
if name[:2] == "__" or name == 'trait_names':
raise AttributeError, name
name_l = name.lower()
cmd_info = None
if not hasattr(self, '__cmd_cache'):
try:
self.__refresh_cmd_cache()
except:
pass
try:
cmd_info = self.__cmd_cache[name_l]
except:
pass
if cmd_info is not None:
d, f = cmd_info
if f is None:
doc = "%s(%s) -> %s\n\n" % (d.cmd_name, d.in_type, d.out_type)
doc += " - in (%s): %s\n" % (d.in_type, d.in_type_desc)
doc += " - out (%s): %s\n" % (d.out_type, d.out_type_desc)
def f(*args,**kwds): return self.command_inout(name, *args, **kwds)
f.__doc__ = doc
self.__cmd_cache[name_l] = d, f
return f
find_attr = True
if not hasattr(self, '__attr_cache') or name_l not in self.__attr_cache:
try:
self.__refresh_attr_cache()
except:
find_attr = False
if not find_attr or name_l not in self.__attr_cache:
raise AttributeError, name
return self.read_attribute(name).value
def __DeviceProxy__setattr(self, name, value):
try:
if not hasattr(self, '__attr_cache') or name.lower() not in self.__attr_cache:
self.__refresh_attr_cache()
except:
self.__dict__[name] = value
return
if name.lower() in self.__attr_cache:
self.write_attribute(name, value)
else:
self.__dict__[name] = value
def __DeviceProxy__getAttributeNames(self):
"""Return list of magic attributes to extend introspection."""
try:
lst = [cmd.cmd_name for cmd in self.command_list_query()]
lst += self.get_attribute_list()
lst += map(str.lower, lst)
lst.sort()
return lst
except Exception:
pass
return []
def __DeviceProxy__getitem(self, key):
return self.read_attribute(key)
def __DeviceProxy__setitem(self, key, value):
return self.write_attribute(key, value)
def __DeviceProxy__contains(self, key):
return key.lower() in map(str.lower, self.get_attribute_list())
def __DeviceProxy__read_attribute(self, value, extract_as=ExtractAs.Numpy):
return __check_read_attribute(self._read_attribute(value, extract_as))
def __DeviceProxy__read_attributes_asynch(self, attr_names, cb=None, extract_as=ExtractAs.Numpy):
"""
read_attributes_asynch( self, attr_names) -> int
Read asynchronously (polling model) the list of specified attributes.
Parameters :
- attr_names : (sequence<str>) A list of attributes to read.
It should be a StdStringVector or a sequence of str.
Return : an asynchronous call identifier which is needed to get
attributes value.
Throws : ConnectionFailed
New in PyTango 7.0.0
read_attributes_asynch( self, attr_names, callback, extract_as=Numpy) -> None
Read asynchronously (callback model) an attribute list.
Parameters :
- attr_names : (sequence<str>) A list of attributes to read. See read_attributes.
- callback : (callable) This callback object should be an instance of a
user class with an attr_read() method. It can also
be any callable object.
- extract_as : (ExtractAs) Defaults to numpy.
Return : None
Throws : ConnectionFailed
New in PyTango 7.0.0
"""
if cb is None:
return self.__read_attributes_asynch(attr_names)
cb2 = __CallBackAutoDie()
if callable(cb):
cb2.attr_read = cb
else:
cb2.attr_read = cb.attr_read
return self.__read_attributes_asynch(attr_names, cb2, extract_as)
def __DeviceProxy__read_attribute_asynch(self, attr_name, cb=None):
"""
read_attribute_asynch( self, attr_name) -> int
read_attribute_asynch( self, attr_name, callback) -> None
Shortcut to self.read_attributes_asynch([attr_name], cb)
New in PyTango 7.0.0
"""
return self.read_attributes_asynch([attr_name], cb)
def __DeviceProxy__read_attribute_reply(self, *args, **kwds):
"""
read_attribute_reply( self, id, extract_as) -> int
read_attribute_reply( self, id, timeout, extract_as) -> None
Shortcut to self.read_attributes_reply()[0]
New in PyTango 7.0.0
"""
return __check_read_attribute(self.read_attributes_reply(*args, **kwds)[0])
def __DeviceProxy__write_attributes_asynch(self, attr_values, cb=None):
"""
write_attributes_asynch( self, values) -> int
Write asynchronously (polling model) the specified attributes.
Parameters :
- values : (any) See write_attributes.
Return : An asynchronous call identifier which is needed to get the
server reply
Throws : ConnectionFailed
New in PyTango 7.0.0
write_attributes_asynch( self, values, callback) -> None
Write asynchronously (callback model) a single attribute.
Parameters :
- values : (any) See write_attributes.
- callback : (callable) This callback object should be an instance of a user
class with an attr_written() method . It can also be any
callable object.
Return : None
Throws : ConnectionFailed
New in PyTango 7.0.0
"""
if cb is None:
return self.__write_attributes_asynch(attr_values)
cb2 = __CallBackAutoDie()
if callable(cb):
cb2.attr_write = cb
else:
cb2.attr_write = cb.attr_write
return self.__write_attributes_asynch(attr_values, cb2)
def __DeviceProxy__write_attribute_asynch(self, attr_name, value, cb=None):
"""
write_attributes_asynch( self, values) -> int
write_attributes_asynch( self, values, callback) -> None
Shortcut to self.write_attributes_asynch([attr_name, value], cb)
New in PyTango 7.0.0
"""
return self.write_attributes_asynch([(attr_name, value)], cb)
def __DeviceProxy__write_read_attribute(self, attr_name, value, extract_as=ExtractAs.Numpy):
return __check_read_attribute(self._write_read_attribute(attr_name, value, extract_as))
def __DeviceProxy__get_property(self, propname, value=None):
"""
get_property(propname, value=None) -> PyTango.DbData
Get a (list) property(ies) for a device.
This method accepts the following types as propname parameter:
1. string [in] - single property data to be fetched
2. sequence<string> [in] - several property data to be fetched
3. PyTango.DbDatum [in] - single property data to be fetched
4. PyTango.DbData [in,out] - several property data to be fetched.
5. sequence<DbDatum> - several property data to be feteched
Note: for cases 3, 4 and 5 the 'value' parameter if given, is IGNORED.
If value is given it must be a PyTango.DbData that will be filled with the
property values
Parameters :
- propname : (any) property(ies) name(s)
- value : (DbData) (optional, default is None meaning that the
method will create internally a PyTango.DbData and return
it filled with the property values
Return : (DbData) object containing the property(ies) value(s). If a
PyTango.DbData is given as parameter, it returns the same
object otherwise a new PyTango.DbData is returned
Throws : NonDbDevice, ConnectionFailed (with database),
CommunicationFailed (with database),
DevFailed from database device
"""
if type(propname) in types.StringTypes or isinstance(propname, StdStringVector):
new_value = value
if new_value is None:
new_value = DbData()
self._get_property(propname, new_value)
return DbData_2_dict(new_value)
elif isinstance(propname, DbDatum):
new_value = DbData()
new_value.append(propname)
self._get_property(new_value)
return DbData_2_dict(new_value)
elif operator.isSequenceType(propname):
if isinstance(propname, DbData):
self._get_property(propname)
return DbData_2_dict(propname)
if type(propname[0]) in types.StringTypes:
new_propname = StdStringVector()
for i in propname: new_propname.append(i)
new_value = value
if new_value is None:
new_value = DbData()
self._get_property(new_propname, new_value)
return DbData_2_dict(new_value)
elif isinstance(propname[0], DbDatum):
new_value = DbData()
for i in propname: new_value.append(i)
self._get_property(new_value)
return DbData_2_dict(new_value)
def __DeviceProxy__put_property(self, value):
"""
put_property(self, value) -> None
Insert or update a list of properties for this device.
This method accepts the following types as value parameter:
1. PyTango.DbDatum - single property data to be inserted
2. PyTango.DbData - several property data to be inserted
3. sequence<DbDatum> - several property data to be inserted
4. dict<str, DbDatum> - keys are property names and value has data to be inserted
5. dict<str, seq<str>> - keys are property names and value has data to be inserted
6. dict<str, obj> - keys are property names and str(obj) is property value
Parameters :
- value : can be one of the following:
1. PyTango.DbDatum - single property data to be inserted
2. PyTango.DbData - several property data to be inserted
3. sequence<DbDatum> - several property data to be inserted
4. dict<str, DbDatum> - keys are property names and value has data to be inserted
5. dict<str, seq<str>> - keys are property names and value has data to be inserted
6. dict<str, obj> - keys are property names and str(obj) is property value
Return : None
Throws : ConnectionFailed, CommunicationFailed
DevFailed from device (DB_SQLError)
"""
if isinstance(value, DbData):
pass
elif isinstance(value, DbDatum):
new_value = DbData()
new_value.append(value)
value = new_value
elif operator.isSequenceType(value) and not type(value) in types.StringTypes:
new_value = seq_2_DbData(value)
elif operator.isMappingType(value):
new_value = DbData()
for k, v in value.iteritems():
if isinstance(v, DbDatum):
new_value.append(v)
continue
db_datum = DbDatum(k)
if operator.isSequenceType(v) and not type(v) in types.StringTypes:
seq_2_StdStringVector(v, db_datum.value_string)
else:
db_datum.value_string.append(str(v))
new_value.append(db_datum)
value = new_value
else:
raise TypeError('value must be a PyTango.DbDatum, PyTango.DbData,'\
'a sequence<DbDatum> or a dictionary')
return self._put_property(value)
def __DeviceProxy__delete_property(self, value):
"""
delete_property(self, value)
Delete a the given of properties for this device.
This method accepts the following types as value parameter:
1. string [in] - single property to be deleted
2. PyTango.DbDatum [in] - single property data to be deleted
3. PyTango.DbData [in] - several property data to be deleted
4. sequence<string> [in]- several property data to be deleted
5. sequence<DbDatum> [in] - several property data to be deleted
6. dict<str, obj> [in] - keys are property names to be deleted (values are ignored)
7. dict<str, DbDatum> [in] - several DbDatum.name are property names to be deleted (keys are ignored)
Parameters :
- value : can be one of the following:
1. string [in] - single property data to be deleted
2. PyTango.DbDatum [in] - single property data to be deleted
3. PyTango.DbData [in] - several property data to be deleted
4. sequence<string> [in]- several property data to be deleted
5. sequence<DbDatum> [in] - several property data to be deleted
6. dict<str, obj> [in] - keys are property names to be deleted (values are ignored)
7. dict<str, DbDatum> [in] - several DbDatum.name are property names to be deleted (keys are ignored)
Return : None
Throws : ConnectionFailed, CommunicationFailed
DevFailed from device (DB_SQLError)
"""
if isinstance(value, DbData) or isinstance(value, StdStringVector) or \
type(value) in types.StringTypes:
new_value = value
elif isinstance(value, DbDatum):
new_value = DbData()
new_value.append(value)
elif operator.isSequenceType(value):
new_value = DbData()
for e in value:
if isinstance(e, DbDatum):
new_value.append(e)
else:
new_value.append(DbDatum(str(e)))
elif operator.isMappingType(value):
new_value = DbData()
for k, v in value.iteritems():
if isinstance(v, DbDatum):
new_value.append(v)
else:
new_value.append(DbDatum(k))
else:
raise TypeError('value must be a string, PyTango.DbDatum, '\
'PyTango.DbData, a sequence or a dictionary')
return self._delete_property(new_value)
def __DeviceProxy__get_property_list(self, filter, array=None):
"""
get_property_list(self, filter, array=None) -> obj
Get the list of property names for the device. The parameter
filter allows the user to filter the returned name list. The
wildcard character is '*'. Only one wildcard character is
allowed in the filter parameter.
Parameters :
- filter[in] : (str) the filter wildcard
- array[out] : (sequence obj or None) (optional, default is None)
an array to be filled with the property names. If None
a new list will be created internally with the values.
Return : the given array filled with the property names (or a new list
if array is None)
Throws : NonDbDevice, WrongNameSyntax,
ConnectionFailed (with database),
CommunicationFailed (with database)
DevFailed from database device
New in PyTango 7.0.0
"""
if array is None:
new_array = StdStringVector()
self._get_property_list(filter, new_array)
return new_array
if isinstance(array, StdStringVector):
self._get_property_list(filter, array)
return array
elif operator.isSequenceType(array):
new_array = StdStringVector()
self._get_property_list(filter, new_array)
StdStringVector_2_seq(new_array, array)
return array
raise TypeError('array must be a mutable sequence<string>')
def __DeviceProxy__get_attribute_config(self, value):
"""
get_attribute_config( self, name) -> AttributeInfoEx
Return the attribute configuration for a single attribute.
Parameters :
- name : (str) attribute name
Return : (AttributeInfoEx) Object containing the attribute
information
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
Deprecated: use get_attribute_config_ex instead
get_attribute_config( self, names) -> AttributeInfoList
Return the attribute configuration for the list of specified attributes. To get all the
attributes pass a sequence containing the constant PyTango.constants.AllAttr
Parameters :
- names : (sequence<str>) attribute names
Return : (AttributeInfoList) Object containing the attributes
information
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
Deprecated: use get_attribute_config_ex instead
"""
if isinstance(value, StdStringVector) or type(value) in types.StringTypes:
return self._get_attribute_config(value)
elif operator.isSequenceType(value):
v = seq_2_StdStringVector(value)
return self._get_attribute_config(v)
raise TypeError('value must be a string or a sequence<string>')
def __DeviceProxy__get_attribute_config_ex(self, value):
"""
get_attribute_config_ex( self, name) -> AttributeInfoListEx :
Return the extended attribute configuration for a single attribute.
Parameters :
- name : (str) attribute name
Return : (AttributeInfoEx) Object containing the attribute
information
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
get_attribute_config( self, names) -> AttributeInfoListEx :
Return the extended attribute configuration for the list of
specified attributes. To get all the attributes pass a sequence
containing the constant PyTango.constants.AllAttr
Parameters :
- names : (sequence<str>) attribute names
Return : (AttributeInfoList) Object containing the attributes
information
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
"""
if isinstance(value, StdStringVector):
return self._get_attribute_config_ex(value)
elif type(value) in types.StringTypes:
v = StdStringVector()
v.append(value)
return self._get_attribute_config_ex(v)
elif operator.isSequenceType(value):
v = seq_2_StdStringVector(value)
return self._get_attribute_config_ex(v)
raise TypeError('value must be a string or a sequence<string>')
def __DeviceProxy__set_attribute_config(self, value):
"""
set_attribute_config( self, attr_info) -> None
Change the attribute configuration for the specified attribute
Parameters :
- attr_info : (AttributeInfo) attribute information
Return : None
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
set_attribute_config( self, attr_info_ex) -> None
Change the extended attribute configuration for the specified attribute
Parameters :
- attr_info_ex : (AttributeInfoEx) extended attribute information
Return : None
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
set_attribute_config( self, attr_info) -> None
Change the attributes configuration for the specified attributes
Parameters :
- attr_info : (sequence<AttributeInfo>) attributes information
Return : None
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
set_attribute_config( self, attr_info_ex) -> None
Change the extended attributes configuration for the specified attributes
Parameters :
- attr_info_ex : (sequence<AttributeInfoListEx>) extended
attributes information
Return : None
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
"""
if isinstance(value, AttributeInfoEx):
v = AttributeInfoListEx()
v.append(value)
elif isinstance(value, AttributeInfo):
v = AttributeInfoList()
v.append(value)
elif isinstance(value, AttributeInfoList):
v = value
elif isinstance(value, AttributeInfoListEx):
v = value
elif operator.isSequenceType(value):
if not len(value): return
if isinstance(value[0], AttributeInfoEx):
v = AttributeInfoListEx()
elif isinstance(value[0], AttributeInfo):
v = AttributeInfoList()
else:
raise TypeError('value must be a AttributeInfo, AttributeInfoEx, ' \
'sequence<AttributeInfo> or sequence<AttributeInfoEx')
for i in value: v.append(i)
else:
raise TypeError('value must be a AttributeInfo, AttributeInfoEx, ' \
'sequence<AttributeInfo> or sequence<AttributeInfoEx')
return self._set_attribute_config(v)
def __DeviceProxy__get_event_map_lock(self):
"""
Internal helper method"""
if not hasattr(self, '_subscribed_events_lock'):
# do it like this instead of self._subscribed_events = dict() to avoid
# calling __setattr__ which requests list of tango attributes from device
self.__dict__['_subscribed_events_lock'] = threading.Lock()
return self._subscribed_events_lock
def __DeviceProxy__get_event_map(self):
"""
Internal helper method"""
if not hasattr(self, '_subscribed_events'):
# do it like this instead of self._subscribed_events = dict() to avoid
# calling __setattr__ which requests list of tango attributes from device
self.__dict__['_subscribed_events'] = dict()
return self._subscribed_events
def __DeviceProxy__subscribe_event ( self, attr_name, event_type, cb_or_queuesize, filters=[], stateless=False, extract_as=ExtractAs.Numpy):
"""
subscribe_event(self, attr_name, event, callback, filters=[], stateless=False, extract_as=Numpy) -> int
The client call to subscribe for event reception in the push model.
The client implements a callback method which is triggered when the
event is received. Filtering is done based on the reason specified and
the event type. For example when reading the state and the reason
specified is "change" the event will be fired only when the state
changes. Events consist of an attribute name and the event reason.
A standard set of reasons are implemented by the system, additional
device specific reasons can be implemented by device servers programmers.
Parameters :
- attr_name : (str) The device attribute name which will be sent
as an event e.g. "current".
- event_type: (EventType) Is the event reason and must be on the enumerated values:
* EventType.CHANGE_EVENT
* EventType.PERIODIC_EVENT
* EventType.ARCHIVE_EVENT
* EventType.ATTR_CONF_EVENT
* EventType.DATA_READY_EVENT
* EventType.USER_EVENT
- callback : (callable) Is any callable object or an object with a
callable "push_event" method.
- filters : (sequence<str>) A variable list of name,value pairs
which define additional filters for events.
- stateless : (bool) When the this flag is set to false, an exception will
be thrown when the event subscription encounters a problem.
With the stateless flag set to true, the event subscription
will always succeed, even if the corresponding device server
is not running. The keep alive thread will try every 10
seconds to subscribe for the specified event. At every
subscription retry, a callback is executed which contains
the corresponding exception
- extract_as : (ExtractAs)
Return : An event id which has to be specified when unsubscribing
from this event.
Throws : EventSystemFailed
subscribe_event(self, attr_name, event, queuesize, filters=[], stateless=False ) -> int
The client call to subscribe for event reception in the pull model.
Instead of a callback method the client has to specify the size of the
event reception buffer.
The event reception buffer is implemented as a round robin buffer. This
way the client can set-up different ways to receive events:
* Event reception buffer size = 1 : The client is interested only
in the value of the last event received. All other events that
have been received since the last reading are discarded.
* Event reception buffer size > 1 : The client has chosen to keep
an event history of a given size. When more events arrive since
the last reading, older events will be discarded.
* Event reception buffer size = ALL_EVENTS : The client buffers all
received events. The buffer size is unlimited and only restricted
by the available memory for the client.
All other parameters are similar to the descriptions given in the
other subscribe_event() version.
"""
if callable(cb_or_queuesize):
cb = __CallBackPushEvent()
cb.push_event = cb_or_queuesize
elif hasattr(cb_or_queuesize, "push_event") and callable(cb_or_queuesize.push_event):
cb = __CallBackPushEvent()
cb.push_event = cb_or_queuesize.push_event
elif operator.isNumberType(cb_or_queuesize):
cb = cb_or_queuesize # queuesize
else:
raise TypeError("Parameter cb_or_queuesize should be a number, a" + \
" callable object or an object with a 'push_event' method.")
event_id = self.__subscribe_event(attr_name, event_type, cb, filters, stateless, extract_as)
with self.__get_event_map_lock():
se = self.__get_event_map()
evt_data = se.get(event_id)
if evt_data is not None:
desc = "Internal PyTango error:\n" \
"%s.subscribe_event(%s, %s) already has key %d assigned to (%s, %s)\n" \
"Please report error to PyTango" % \
(self, attr_name, event_type, event_id, evt_data[2], evt_data[1])
Except.throw_exception("Py_InternalError", desc, "DeviceProxy.subscribe_event")
se[event_id] = (cb, event_type, attr_name)
return event_id
def __DeviceProxy__unsubscribe_event(self, event_id):
"""
unsubscribe_event(self, event_id) -> None
Unsubscribes a client from receiving the event specified by event_id.
Parameters :
- event_id : (int) is the event identifier returned by the
DeviceProxy::subscribe_event(). Unlike in
TangoC++ we chech that the event_id has been
subscribed in this DeviceProxy.
Return : None
Throws : EventSystemFailed
"""
with self.__get_event_map_lock():
se = self.__get_event_map()
if event_id not in se:
raise IndexError("This device proxy does not own this subscription " + str(event_id))
del se[event_id]
self.__unsubscribe_event(event_id)
def __DeviceProxy__unsubscribe_event_all(self):
with self.__get_event_map_lock():
se = self.__get_event_map()
event_ids = se.keys()
se.clear()
for event_id in event_ids:
self.__unsubscribe_event(event_id)
def __DeviceProxy__get_events(self, event_id, callback=None, extract_as=ExtractAs.Numpy):
"""
get_events( event_id, callback=None, extract_as=Numpy) -> None
The method extracts all waiting events from the event reception buffer.
If callback is not None, it is executed for every event. During event
subscription the client must have chosen the pull model for this event.
The callback will receive a parameter of type EventData,
AttrConfEventData or DataReadyEventData depending on the type of the
event (event_type parameter of subscribe_event).
If callback is None, the method extracts all waiting events from the
event reception buffer. The returned event_list is a vector of
EventData, AttrConfEventData or DataReadyEventData pointers, just
the same data the callback would have received.
Parameters :
- event_id : (int) is the event identifier returned by the
DeviceProxy.subscribe_event() method.
- callback : (callable) Any callable object or any object with a "push_event"
method.
- extract_as: (ExtractAs)
Return : None
Throws : EventSystemFailed
See Also : subscribe_event
New in PyTango 7.0.0
"""
if callback is None:
queuesize, event_type, attr_name = self.__get_event_map().get(event_id, (None, None, None))
if event_type is None:
raise ValueError("Invalid event_id. You are not subscribed to event %s." % str(event_id))
if event_type in [ EventType.CHANGE_EVENT,
EventType.QUALITY_EVENT,
EventType.PERIODIC_EVENT,
EventType.ARCHIVE_EVENT,
EventType.USER_EVENT ]:
return self.__get_data_events(event_id, extract_as)
elif event_type in [ EventType.ATTR_CONF_EVENT ]:
return self.__get_attr_conf_events(event_id, extract_as)
elif event_type in [ EventType.DATA_READY_EVENT ]:
return self.__get_data_ready_events(event_id, extract_as)
else:
assert (False)
raise ValueError("Unknown event_type: " + str(event_type))
elif callable(callback):
cb = __CallBackPushEvent()
cb.push_event = callback
return self.__get_callback_events(event_id, cb, extract_as)
elif hasattr(callback, 'push_event') and callable(callback.push_event):
cb = __CallBackPushEvent()
cb.push_event = callback.push_event
return self.__get_callback_events(event_id, cb, extract_as)
else:
raise TypeError("Parameter 'callback' should be None, a callable object or an object with a 'push_event' method.")
def __DeviceProxy__str(self):
if not hasattr(self, '_dev_class'):
try:
self.__dict__["_dev_class"] = self.info().dev_class
except:
return "DeviceProxy(%s)" % self.dev_name()
return "%s(%s)" % (self._dev_class, self.dev_name())
def __init_DeviceProxy():
DeviceProxy.__getattr__ = __DeviceProxy__getattr
DeviceProxy.__setattr__ = __DeviceProxy__setattr
DeviceProxy.__getitem__ = __DeviceProxy__getitem
DeviceProxy.__setitem__ = __DeviceProxy__setitem
DeviceProxy.__contains__ = __DeviceProxy__contains
DeviceProxy._getAttributeNames = __DeviceProxy__getAttributeNames
DeviceProxy.__refresh_cmd_cache = __DeviceProxy__refresh_cmd_cache
DeviceProxy.__refresh_attr_cache = __DeviceProxy__refresh_attr_cache
DeviceProxy.read_attribute = __DeviceProxy__read_attribute
DeviceProxy.read_attributes_asynch = __DeviceProxy__read_attributes_asynch
DeviceProxy.read_attribute_asynch = __DeviceProxy__read_attribute_asynch
DeviceProxy.read_attribute_reply = __DeviceProxy__read_attribute_reply
DeviceProxy.write_attributes_asynch = __DeviceProxy__write_attributes_asynch
DeviceProxy.write_attribute_asynch = __DeviceProxy__write_attribute_asynch
DeviceProxy.write_attribute_reply = DeviceProxy.write_attributes_reply
DeviceProxy.write_read_attribute = __DeviceProxy__write_read_attribute
DeviceProxy.get_property = __DeviceProxy__get_property
DeviceProxy.put_property = __DeviceProxy__put_property
DeviceProxy.delete_property = __DeviceProxy__delete_property
DeviceProxy.get_property_list = __DeviceProxy__get_property_list
DeviceProxy.get_attribute_config = __DeviceProxy__get_attribute_config
DeviceProxy.get_attribute_config_ex = __DeviceProxy__get_attribute_config_ex
DeviceProxy.set_attribute_config = __DeviceProxy__set_attribute_config
DeviceProxy.__get_event_map = __DeviceProxy__get_event_map
DeviceProxy.__get_event_map_lock = __DeviceProxy__get_event_map_lock
DeviceProxy.subscribe_event = __DeviceProxy__subscribe_event
DeviceProxy.unsubscribe_event = __DeviceProxy__unsubscribe_event
DeviceProxy.__unsubscribe_event_all = __DeviceProxy__unsubscribe_event_all
DeviceProxy.get_events = __DeviceProxy__get_events
DeviceProxy.__str__ = __DeviceProxy__str
DeviceProxy.__repr__ = __DeviceProxy__str
def __doc_DeviceProxy():
def document_method(method_name, desc, append=True):
return __document_method(DeviceProxy, method_name, desc, append)
DeviceProxy.__doc__ = """
DeviceProxy is the high level Tango object which provides the client with
an easy-to-use interface to TANGO devices. DeviceProxy provides interfaces
to all TANGO Device interfaces.The DeviceProxy manages timeouts, stateless
connections and reconnection if the device server is restarted. To create
a DeviceProxy, a Tango Device name must be set in the object constructor.
Example :
dev = PyTango.DeviceProxy("sys/tg_test/1")
"""
#-------------------------------------
# General methods
#-------------------------------------
document_method("info", """
info(self) -> DeviceInfo
A method which returns information on the device
Parameters : None
Return : (DeviceInfo) object
Example :
dev_info = dev.info()
print dev_info.dev_class
print dev_info.server_id
print dev_info.server_host
print dev_info.server_version
print dev_info.doc_url
print dev_info.dev_type
All DeviceInfo fields are strings except for the server_version
which is an integer"
""" )
document_method("get_device_db", """
get_device_db(self) -> Database
Returns the internal database reference
Parameters : None
Return : (Database) object
New in PyTango 7.0.0
""" )
document_method("status", """
status(self) -> str
A method which returns the status of the device as a string.
Parameters : None
Return : (str) describing the device status
""" )
document_method("state", """
state(self) -> DevState
A method which returns the state of the device.
Parameters : None
Return : (DevState) constant
Example :
dev_st = dev.state()
if dev_st == DevState.ON : ...
""" )
document_method("adm_name", """
adm_name(self) -> str
Return the name of the corresponding administrator device. This is
useful if you need to send an administration command to the device
server, e.g restart it
New in PyTango 3.0.4
""" )
document_method("description", """
description(self) -> str
Get device description.
Parameters : None
Return : (str) describing the device
""" )
document_method("name", """
name(self) -> str
Return the device name from the device itself.
""" )
document_method("alias", """
alias(self) -> str
Return the device alias if one is defined.
Otherwise, throws exception.
""" )
document_method("ping", """
ping(self) -> int
A method which sends a ping to the device
Parameters : None
Return : (int) time elapsed in milliseconds
Throws : exception if device is not alive
""" )
document_method("black_box", """
black_box(self, n) -> sequence<str>
Get the last commands executed on the device server
Parameters :
- n : n number of commands to get
Return : (sequence<str>) sequence of strings containing the date, time,
command and from which client computer the command
was executed
Example :
print black_box(4)
""" )
#-------------------------------------
# Device methods
#-------------------------------------
document_method("command_query", """
command_query(self, command) -> CommandInfo
Query the device for information about a single command.
Parameters :
- command : (str) command name
Return : (CommandInfo) object
Throws : ConnectionFailed, CommunicationFailed, DevFailed from device
Example :
com_info = dev.command_query(""DevString"")
print com_info.cmd_name
print com_info.cmd_tag
print com_info.in_type
print com_info.out_type
print com_info.in_type_desc
print com_info.out_type_desc
print com_info.disp_level
See CommandInfo documentation string form more detail
""" )
document_method("command_list_query", """
command_list_query(self) -> sequence<CommandInfo>
Query the device for information on all commands.
Parameters : None
Return : (CommandInfoList) Sequence of CommandInfo objects
""" )
document_method("import_info", """
import_info(self) -> DbDevImportInfo
Query the device for import info from the database.
Parameters : None
Return : (DbDevImportInfo)
Example :
dev_import = dev.import_info()
print dev_import.name
print dev_import.exported
print dev_ior.ior
print dev_version.version
All DbDevImportInfo fields are strings except for exported which
is an integer"
""" )
#-------------------------------------
# Property methods
#-------------------------------------
# get_property -> in code
# put_property -> in code
# delete_property -> in code
# get_property_list -> in code
#-------------------------------------
# Attribute methods
#-------------------------------------
document_method("get_attribute_list", """
get_attribute_list(self) -> sequence<str>
Return the names of all attributes implemented for this device.
Parameters : None
Return : sequence<str>
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
""" )
# get_attribute_config -> in code
# get_attribute_config_ex -> in code
document_method("attribute_query", """
attribute_query(self, attr_name) -> AttributeInfoEx
Query the device for information about a single attribute.
Parameters :
- attr_name :(str) the attribute name
Return : (AttributeInfoEx) containing the attribute
configuration
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
""" )
document_method("attribute_list_query", """
attribute_list_query(self) -> sequence<AttributeInfo>
Query the device for info on all attributes. This method returns
a sequence of PyTango.AttributeInfo.
Parameters : None
Return : (sequence<AttributeInfo>) containing the
attributes configuration
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
""" )
document_method("attribute_list_query_ex", """
attribute_list_query_ex(self) -> sequence<AttributeInfoEx>
Query the device for info on all attributes. This method returns
a sequence of PyTango.AttributeInfoEx.
Parameters : None
Return : (sequence<AttributeInfoEx>) containing the
attributes configuration
Throws : ConnectionFailed, CommunicationFailed,
DevFailed from device
""" )
# set_attribute_config -> in code
document_method("read_attribute", """
read_attribute(self, attr_name, extract_as=ExtractAs.Numpy) -> DeviceAttribute
Read a single attribute.
Parameters :
- attr_name : (str) The name of the attribute to read.
- extract_as : (ExtractAs) Defaults to numpy.
Return : (DeviceAttribute)
Throws : ConnectionFailed, CommunicationFailed, DevFailed from device
.. versionchanged:: 7.1.4
For DevEncoded attributes, before it was returning a DeviceAttribute.value
as a tuple **(format<str>, data<str>)** no matter what was the *extract_as*
value was. Since 7.1.4, it returns a **(format<str>, data<buffer>)**
unless *extract_as* is String, in which case it returns
**(format<str>, data<str>)**.
""" )
document_method("read_attributes", """
read_attributes(self, attr_names, extract_as=ExtractAs.Numpy) -> sequence<DeviceAttribute>
Read the list of specified attributes.
Parameters :
- attr_names : (sequence<str>) A list of attributes to read.
- extract_as : (ExtractAs) Defaults to numpy.
Return : (sequence<DeviceAttribute>)
Throws : ConnectionFailed, CommunicationFailed, DevFailed from device
""" )
document_method("write_attribute", """
write_attribute(self, attr_name, value) -> None
write_attribute(self, attr_info, value) -> None
Write a single attribute.
Parameters :
- attr_name : (str) The name of the attribute to write.
- attr_info : (AttributeInfo)
- value : The value. For non SCALAR attributes it may be any sequence of sequences.
Throws : ConnectionFailed, CommunicationFailed, DeviceUnlocked, DevFailed from device
""" )
document_method("write_attributes", """
write_attributes(self, name_val) -> None
Write the specified attributes.
Parameters :
- name_val: A list of pairs (attr_name, value). See write_attribute
Throws : ConnectionFailed, CommunicationFailed, DeviceUnlocked,
DevFailed or NamedDevFailedList from device
""" )
document_method("write_read_attribute", """
write_read_attribute(self, attr_name, value, extract_as=ExtractAs.Numpy) -> DeviceAttribute
Write then read a single attribute in a single network call.
By default (serialisation by device), the execution of this call in
the server can't be interrupted by other clients.
Parameters : see write_attribute(attr_name, value)
Return : A PyTango.DeviceAttribute object.
Throws : ConnectionFailed, CommunicationFailed, DeviceUnlocked,
DevFailed from device, WrongData
New in PyTango 7.0.0
""" )
#-------------------------------------
# History methods
#-------------------------------------
document_method("command_history", """
command_history(self, cmd_name, depth) -> sequence<DeviceDataHistory>
Retrieve command history from the command polling buffer. See
chapter on Advanced Feature for all details regarding polling
Parameters :
- cmd_name : (str) Command name.
- depth : (int) The wanted history depth.
Return : This method returns a vector of DeviceDataHistory types.
Throws : NonSupportedFeature, ConnectionFailed,
CommunicationFailed, DevFailed from device
""" )
document_method("attribute_history", """
attribute_history(self, attr_name, depth, extract_as=ExtractAs.Numpy) -> sequence<DeviceAttributeHistory>
Retrieve attribute history from the attribute polling buffer. See
chapter on Advanced Feature for all details regarding polling
Parameters :
- attr_name : (str) Attribute name.
- depth : (int) The wanted history depth.
- extract_as : (ExtractAs)
Return : This method returns a vector of DeviceAttributeHistory types.
Throws : NonSupportedFeature, ConnectionFailed,
CommunicationFailed, DevFailed from device
""" )
#-------------------------------------
# Polling administration methods
#-------------------------------------
document_method("polling_status", """
polling_status(self) -> sequence<str>
Return the device polling status.
Parameters : None
Return : (sequence<str>) One string for each polled command/attribute.
Each string is multi-line string with:
- attribute/command name
- attribute/command polling period in milliseconds
- attribute/command polling ring buffer
- time needed for last attribute/command execution in milliseconds
- time since data in the ring buffer has not been updated
- delta time between the last records in the ring buffer
- exception parameters in case of the last execution failed
""" )
document_method("poll_command", """
poll_command(self, cmd_name, period) -> None
Add a command to the list of polled commands.
Parameters :
- cmd_name : (str) command name
- period : (int) polling period in milliseconds
Return : None
""" )
document_method("poll_attribute", """
poll_attribute(self, attr_name, period) -> None
Add an attribute to the list of polled attributes.
Parameters :
- attr_name : (str) attribute name
- period : (int) polling period in milliseconds
Return : None
""" )
document_method("get_command_poll_period", """
get_command_poll_period(self, cmd_name) -> int
Return the command polling period.
Parameters :
- cmd_name : (str) command name
Return : polling period in milliseconds
""" )
document_method("get_attribute_poll_period", """
get_attribute_poll_period(self, attr_name) -> int
Return the attribute polling period.
Parameters :
- attr_name : (str) attribute name
Return : polling period in milliseconds
""" )
document_method("is_command_polled", """
is_command_polled(self, cmd_name) -> bool
True if the command is polled.
Parameters :
- cmd_name : (str) command name
Return : boolean value
""" )
document_method("is_attribute_polled", """
is_attribute_polled(self, attr_name) -> bool
True if the attribute is polled.
Parameters :
- attr_name : (str) attribute name
Return : boolean value
""" )
document_method("stop_poll_command", """
stop_poll_command(self, cmd_name) -> None
Remove a command from the list of polled commands.
Parameters :
- cmd_name : (str) command name
Return : None
""" )
document_method("stop_poll_attribute", """
stop_poll_attribute(self, attr_name) -> None
Remove an attribute from the list of polled attributes.
Parameters :
- attr_name : (str) attribute name
Return : None
""" )
#-------------------------------------
# Asynchronous methods
#-------------------------------------
# read_attribute_asynch -> in code
# read_attributes_asynch -> in code
# read_attribute_reply -> in code
document_method("read_attributes_reply", """
read_attributes_reply(self, id, extract_as=ExtractAs.Numpy) -> DeviceAttribute
Check if the answer of an asynchronous read_attribute is
arrived (polling model).
Parameters :
- id : (int) is the asynchronous call identifier.
- extract_as : (ExtractAs)
Return : If the reply is arrived and if it is a valid reply, it is
returned to the caller in a list of DeviceAttribute. If the
reply is an exception, it is re-thrown by this call. An
exception is also thrown in case of the reply is not yet
arrived.
Throws : AsynCall, AsynReplyNotArrived, ConnectionFailed,
CommunicationFailed, DevFailed from device
New in PyTango 7.0.0
read_attributes_reply(self, id, timeout, extract_as=ExtractAs.Numpy) -> DeviceAttribute
Check if the answer of an asynchronous read_attributes is arrived (polling model).
Parameters :
- id : (int) is the asynchronous call identifier.
- timeout : (int)
- extract_as : (ExtractAs)
Return : If the reply is arrived and if it is a valid reply, it is
returned to the caller in a list of DeviceAttribute. If the
reply is an exception, it is re-thrown by this call. If the
reply is not yet arrived, the call will wait (blocking the
process) for the time specified in timeout. If after
timeout milliseconds, the reply is still not there, an
exception is thrown. If timeout is set to 0, the call waits
until the reply arrived.
Throws : AsynCall, AsynReplyNotArrived, ConnectionFailed,
CommunicationFailed, DevFailed from device
New in PyTango 7.0.0
""" )
document_method("pending_asynch_call", """
pending_asynch_call(self) -> int
Return number of device asynchronous pending requests"
New in PyTango 7.0.0
""" )
# write_attributes_asynch -> in code
document_method("write_attributes_reply", """
write_attributes_reply(self, id) -> None
Check if the answer of an asynchronous write_attributes is arrived
(polling model). If the reply is arrived and if it is a valid reply,
the call returned. If the reply is an exception, it is re-thrown by
this call. An exception is also thrown in case of the reply is not
yet arrived.
Parameters :
- id : (int) the asynchronous call identifier.
Return : None
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device.
New in PyTango 7.0.0
write_attributes_reply(self, id, timeout) -> None
Check if the answer of an asynchronous write_attributes is arrived
(polling model). id is the asynchronous call identifier. If the
reply is arrived and if it is a valid reply, the call returned. If
the reply is an exception, it is re-thrown by this call. If the
reply is not yet arrived, the call will wait (blocking the process)
for the time specified in timeout. If after timeout milliseconds,
the reply is still not there, an exception is thrown. If timeout is
set to 0, the call waits until the reply arrived.
Parameters :
- id : (int) the asynchronous call identifier.
- timeout : (int) the timeout
Return : None
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device.
New in PyTango 7.0.0
""" )
document_method("write_attribute_reply", """
write_attribute_reply(self, id) -> None
Check if the answer of an asynchronous write_attribute is arrived
(polling model). If the reply is arrived and if it is a valid reply,
the call returned. If the reply is an exception, it is re-thrown by
this call. An exception is also thrown in case of the reply is not
yet arrived.
Parameters :
- id : (int) the asynchronous call identifier.
Return : None
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device.
New in PyTango 7.0.0
write_attribute_reply(self, id, timeout) -> None
Check if the answer of an asynchronous write_attribute is arrived
(polling model). id is the asynchronous call identifier. If the
reply is arrived and if it is a valid reply, the call returned. If
the reply is an exception, it is re-thrown by this call. If the
reply is not yet arrived, the call will wait (blocking the process)
for the time specified in timeout. If after timeout milliseconds,
the reply is still not there, an exception is thrown. If timeout is
set to 0, the call waits until the reply arrived.
Parameters :
- id : (int) the asynchronous call identifier.
- timeout : (int) the timeout
Return : None
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device.
New in PyTango 7.0.0
""" )
#-------------------------------------
# Logging administration methods
#-------------------------------------
document_method("add_logging_target", """
add_logging_target(self, target_type_target_name) -> None
Adds a new logging target to the device.
The target_type_target_name input parameter must follow the
format: target_type::target_name. Supported target types are:
console, file and device. For a device target, the target_name
part of the target_type_target_name parameter must contain the
name of a log consumer device (as defined in A.8). For a file
target, target_name is the full path to the file to log to. If
omitted, the device's name is used to build the file name
(which is something like domain_family_member.log). Finally, the
target_name part of the target_type_target_name input parameter
is ignored in case of a console target and can be omitted.
Parameters :
- target_type_target_name : (str) logging target
Return : None
Throws : DevFailed from device
New in PyTango 7.0.0
""" )
document_method("remove_logging_target", """
remove_logging_target(self, target_type_target_name) -> None
Removes a logging target from the device's target list.
The target_type_target_name input parameter must follow the
format: target_type::target_name. Supported target types are:
console, file and device. For a device target, the target_name
part of the target_type_target_name parameter must contain the
name of a log consumer device (as defined in ). For a file
target, target_name is the full path to the file to remove.
If omitted, the default log file is removed. Finally, the
target_name part of the target_type_target_name input parameter
is ignored in case of a console target and can be omitted.
If target_name is set to '*', all targets of the specified
target_type are removed.
Parameters :
- target_type_target_name : (str) logging target
Return : None
New in PyTango 7.0.0
""" )
document_method("get_logging_target", """
get_logging_target(self) -> sequence<str>
Returns a sequence of string containing the current device's
logging targets. Each vector element has the following format:
target_type::target_name. An empty sequence is returned is the
device has no logging targets.
Parameters : None
Return : a squence<str> with the logging targets
New in PyTango 7.0.0
""" )
document_method("get_logging_level", """
get_logging_level(self) -> int
Returns the current device's logging level, where:
- 0=OFF
- 1=FATAL
- 2=ERROR
- 3=WARNING
- 4=INFO
- 5=DEBUG
Parameters :None
Return : (int) representing the current logging level
New in PyTango 7.0.0
""" )
document_method("set_logging_level", """
set_logging_level(self, (int)level) -> None
Changes the device's logging level, where:
- 0=OFF
- 1=FATAL
- 2=ERROR
- 3=WARNING
- 4=INFO
- 5=DEBUG
Parameters :
- level : (int) logging level
Return : None
New in PyTango 7.0.0
""" )
#-------------------------------------
# Event methods
#-------------------------------------
# subscribe_event -> in code
# unsubscribe_event -> in code
# get_events -> in code
document_method("event_queue_size", """
event_queue_size(self, event_id) -> int
Returns the number of stored events in the event reception
buffer. After every call to DeviceProxy.get_events(), the event
queue size is 0. During event subscription the client must have
chosen the 'pull model' for this event. event_id is the event
identifier returned by the DeviceProxy.subscribe_event() method.
Parameters :
- event_id : (int) event identifier
Return : an integer with the queue size
Throws : EventSystemFailed
New in PyTango 7.0.0
""" )
document_method("get_last_event_date", """
get_last_event_date(self, event_id) -> TimeVal
Returns the arrival time of the last event stored in the event
reception buffer. After every call to DeviceProxy:get_events(),
the event reception buffer is empty. In this case an exception
will be returned. During event subscription the client must have
chosen the 'pull model' for this event. event_id is the event
identifier returned by the DeviceProxy.subscribe_event() method.
Parameters :
- event_id : (int) event identifier
Return : (PyTango.TimeVal) representing the arrival time
Throws : EventSystemFailed
New in PyTango 7.0.0
""" )
document_method("is_event_queue_empty", """
is_event_queue_empty(self, event_id) -> bool
Returns true when the event reception buffer is empty. During
event subscription the client must have chosen the 'pull model'
for this event. event_id is the event identifier returned by the
DeviceProxy.subscribe_event() method.
Parameters :
- event_id : (int) event identifier
Return : (bool) True if queue is empty or False otherwise
Throws : EventSystemFailed
New in PyTango 7.0.0
""" )
#-------------------------------------
# Locking methods
#-------------------------------------
document_method("lock", """
lock(self, (int)lock_validity) -> None
Lock a device. The lock_validity is the time (in seconds) the
lock is kept valid after the previous lock call. A default value
of 10 seconds is provided and should be fine in most cases. In
case it is necessary to change the lock validity, it's not
possible to ask for a validity less than a minimum value set to
2 seconds. The library provided an automatic system to
periodically re lock the device until an unlock call. No code is
needed to start/stop this automatic re-locking system. The
locking system is re-entrant. It is then allowed to call this
method on a device already locked by the same process. The
locking system has the following features:
* It is impossible to lock the database device or any device
server process admin device
* Destroying a locked DeviceProxy unlocks the device
* Restarting a locked device keeps the lock
* It is impossible to restart a device locked by someone else
* Restarting a server breaks the lock
A locked device is protected against the following calls when
executed by another client:
* command_inout call except for device state and status
requested via command and for the set of commands defined as
allowed following the definition of allowed command in the
Tango control access schema.
* write_attribute call
* write_read_attribute call
* set_attribute_config call
Parameters :
- lock_validity : (int) lock validity time in seconds
(optional, default value is
PyTango.constants.DEFAULT_LOCK_VALIDITY)
Return : None
New in PyTango 7.0.0
""" )
document_method("unlock", """
unlock(self, (bool)force) -> None
Unlock a device. If used, the method argument provides a back
door on the locking system. If this argument is set to true,
the device will be unlocked even if the caller is not the locker.
This feature is provided for administration purpopse and should
be used very carefully. If this feature is used, the locker will
receive a DeviceUnlocked during the next call which is normally
protected by the locking Tango system.
Parameters :
- force : (bool) force unlocking even if we are not the
locker (optional, default value is False)
Return : None
New in PyTango 7.0.0
""" )
document_method("locking_status", """
locking_status(self) -> str
This method returns a plain string describing the device locking
status. This string can be:
* 'Device <device name> is not locked' in case the device is
not locked
* 'Device <device name> is locked by CPP or Python client with
PID <pid> from host <host name>' in case the device is
locked by a CPP client
* 'Device <device name> is locked by JAVA client class
<main class> from host <host name>' in case the device is
locked by a JAVA client
Parameters : None
Return : a string representing the current locking status
New in PyTango 7.0.0"
""" )
document_method("is_locked", """
is_locked(self) -> bool
Returns True if the device is locked. Otherwise, returns False.
Parameters : None
Return : (bool) True if the device is locked. Otherwise, False
New in PyTango 7.0.0
""" )
document_method("is_locked_by_me", """
is_locked_by_me(self) -> bool
Returns True if the device is locked by the caller. Otherwise,
returns False (device not locked or locked by someone else)
Parameters : None
Return : (bool) True if the device is locked by us.
Otherwise, False
New in PyTango 7.0.0
""" )
document_method("get_locker", """
get_locker(self, lockinfo) -> bool
If the device is locked, this method returns True an set some
locker process informations in the structure passed as argument.
If the device is not locked, the method returns False.
Parameters :
- lockinfo [out] : (PyTango.LockInfo) object that will be filled
with lock informantion
Return : (bool) True if the device is locked by us.
Otherwise, False
New in PyTango 7.0.0
""" )
def init(doc=True):
__init_DeviceProxy()
if doc:
__doc_DeviceProxy()
|