/usr/share/doc/python-pytango/html/client/attribute_proxy.html 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>AttributeProxy — PyTango v7.2.2 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '7.2.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="PyTango v7.2.2 documentation" href="../index.html" />
<link rel="up" title="The Tango Device Python API" href="index.html" />
<link rel="next" title="Group" href="group.html" />
<link rel="prev" title="DeviceProxy" href="device_proxy.html" />
<script src="../_static/js/jquery.min.js"></script>
<script src="../_static/js/jquery.mousewheel.min.js"></script>
<script src="../_static/js/jquery.terminal.min.js"></script>
<link href="../_static/css/jquery.terminal.css" rel="stylesheet"/>
<link href="../_static/css/start/jquery-ui-1.8.10.custom.css" rel="stylesheet"/>
<link href="../_static/css/pytango.css" rel="stylesheet"/>
<link href="../_static/css/pytango_terminal.css" rel="stylesheet"/>
<script src="../_static/js/jquery-ui-1.8.10.custom.min.js"></script>
<script src="../_static/js/dterm.js"></script>
<script src="../_static/js/pytango.js"></script>
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="group.html" title="Group"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="device_proxy.html" title="DeviceProxy"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../start.html">getting started</a>| </li>
<li><a href="../quicktour.html">quick tour</a>| </li>
<li><a href="../contents.html">documentation </a> »</li>
<li><a href="../contents.html" >Contents</a> »</li>
<li><a href="../api.html" >PyTango API</a> »</li>
<li><a href="index.html" accesskey="U">The Tango Device Python API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/logo.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="device_proxy.html"
title="previous chapter">DeviceProxy</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="group.html"
title="next chapter">Group</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/client/attribute_proxy.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="attributeproxy">
<h1>AttributeProxy<a class="headerlink" href="#attributeproxy" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="PyTango.AttributeProxy">
<em class="property">class </em><tt class="descclassname">PyTango.</tt><tt class="descname">AttributeProxy</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy" title="Permalink to this definition">¶</a></dt>
<dd><p>AttributeProxy is the high level Tango object which provides the
client with an easy-to-use interface to TANGO attributes.</p>
<p>To create an AttributeProxy, a complete attribute name must be set
in the object constructor.</p>
<dl class="docutils">
<dt>Example:</dt>
<dd>att = AttributeProxy(“tango/tangotest/1/long_scalar”)</dd>
</dl>
<p>Note: PyTango implementation of AttributeProxy is in part a
python reimplementation of the AttributeProxy found on the C++ API.</p>
<dl class="method">
<dt id="PyTango.AttributeProxy.delete_property">
<tt class="descname">delete_property</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.delete_property" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>delete_property</strong> <em>(self, value)</em> <strong>-></strong> <tt class="xref py py-class xref docutils literal"><span class="pre">None</span></tt></p>
<blockquote>
<div><p>Delete a the given of properties for this attribute.
This method accepts the following types as value parameter:</p>
<blockquote>
<div><ol class="arabic simple">
<li>string [in] - single property to be deleted</li>
<li>PyTango.DbDatum [in] - single property data to be deleted</li>
<li>PyTango.DbData [in] - several property data to be deleted</li>
<li>sequence<string> [in]- several property data to be deleted</li>
<li>sequence<DbDatum> [in] - several property data to be deleted</li>
<li>dict<str, obj> [in] - keys are property names to be deleted
(values are ignored)</li>
<li>dict<str, DbDatum> [in] - several DbDatum.name are property names
to be deleted (keys are ignored)</li>
</ol>
</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">value:</th><td class="field-body"><p class="first">can be one of the following:</p>
<ol class="last arabic simple">
<li>string [in] - single property data to be deleted</li>
<li>PyTango.DbDatum [in] - single property data to be deleted</li>
<li>PyTango.DbData [in] - several property data to be deleted</li>
<li>sequence<string> [in]- several property data to be deleted</li>
<li>sequence<DbDatum> [in] - several property data to be deleted</li>
<li>dict<str, obj> [in] - keys are property names to be deleted
(values are ignored)</li>
<li>dict<str, DbDatum> [in] - several DbDatum.name are property
names to be deleted (keys are ignored)</li>
</ol>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device (DB_SQLError)</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.event_queue_size">
<tt class="descname">event_queue_size</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.event_queue_size" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().event_queue_size(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.event_queue_size(...):</p>
<blockquote>
<div><p>event_queue_size(self, event_id) -> int</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">event_id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) event identifier</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">an integer with the queue size</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.EventSystemFailed" title="PyTango.EventSystemFailed"><tt class="xref py py-class docutils literal"><span class="pre">EventSystemFailed</span></tt></a></p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.get_config">
<tt class="descname">get_config</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.get_config" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().get_attribute_config(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.get_attribute_config(...):</p>
<blockquote>
<div><p>get_attribute_config( self, name) -> AttributeInfoEx</p>
<blockquote>
<div><blockquote>
<div>Return the attribute configuration for a single attribute.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) attribute name</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">(<a class="reference internal" href="miscellaneous.html#PyTango.AttributeInfoEx" title="PyTango.AttributeInfoEx"><tt class="xref py py-class docutils literal"><span class="pre">AttributeInfoEx</span></tt></a>) Object containing the attribute
information</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
<p>Deprecated: use get_attribute_config_ex instead</p>
</div></blockquote>
<p>get_attribute_config( self, names) -> <tt class="xref py py-class docutils literal"><span class="pre">AttributeInfoList</span></tt></p>
<blockquote>
<div><blockquote>
<div>Return the attribute configuration for the list of specified attributes. To get all the
attributes pass a sequence containing the constant PyTango.:class:<cite>constants</cite>.AllAttr</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">names:</th><td class="field-body">(sequence<<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>>) attribute names</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">(<tt class="xref py py-class docutils literal"><span class="pre">AttributeInfoList</span></tt>) Object containing the attributes
information</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
<p>Deprecated: use get_attribute_config_ex instead</p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.get_device_proxy">
<tt class="descname">get_device_proxy</tt><big>(</big><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.get_device_proxy" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>get_device_proxy</strong> <em>(self)</em> <strong>-></strong> <a class="reference internal" href="device_proxy.html#PyTango.DeviceProxy" title="PyTango.DeviceProxy"><tt class="xref py py-class docutils literal"><span class="pre">DeviceProxy</span></tt></a></p>
<blockquote>
<div><blockquote>
<div>A method which returns the device associated to the attribute</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body">(<a class="reference internal" href="device_proxy.html#PyTango.DeviceProxy" title="PyTango.DeviceProxy"><tt class="xref py py-class docutils literal"><span class="pre">DeviceProxy</span></tt></a>)</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.get_events">
<tt class="descname">get_events</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.get_events" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().get_events(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.get_events(...):</p>
<blockquote>
<div><p>get_events( event_id, callback=None, extract_as=Numpy) -> None</p>
<blockquote>
<div><p>The method extracts all waiting events from the event reception buffer.</p>
<p>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).</p>
<p>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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">event_id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) is the event identifier returned by the
DeviceProxy.subscribe_event() method.</td>
</tr>
<tr class="field"><th class="field-name">callback:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">callable</span></tt>) Any callable object or any object with a “push_event”
method.</td>
</tr>
<tr class="field"><th class="field-name">extract_as:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">ExtractAs</span></tt>)</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first"><a class="reference internal" href="../exception.html#PyTango.EventSystemFailed" title="PyTango.EventSystemFailed"><tt class="xref py py-class docutils literal"><span class="pre">EventSystemFailed</span></tt></a></p>
</td>
</tr>
<tr class="field"><th class="field-name">See Also:</th><td class="field-body"><p class="first last">subscribe_event</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.get_last_event_date">
<tt class="descname">get_last_event_date</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.get_last_event_date" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().get_last_event_date(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.get_last_event_date(...):</p>
<blockquote>
<div><p>get_last_event_date(self, event_id) -> TimeVal</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">event_id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) event identifier</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">(<a class="reference internal" href="other.html#PyTango.TimeVal" title="PyTango.TimeVal"><tt class="xref py py-class docutils literal"><span class="pre">PyTango.TimeVal</span></tt></a>) representing the arrival time</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.EventSystemFailed" title="PyTango.EventSystemFailed"><tt class="xref py py-class docutils literal"><span class="pre">EventSystemFailed</span></tt></a></p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.get_poll_period">
<tt class="descname">get_poll_period</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.get_poll_period" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().get_attribute_poll_period(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.get_attribute_poll_period(...):</p>
<blockquote>
<div><p>get_attribute_poll_period(self, attr_name) -> int</p>
<blockquote>
<div><blockquote>
<div>Return the attribute polling period.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) attribute name</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">polling period in milliseconds</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.get_property">
<tt class="descname">get_property</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.get_property" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>get_property</strong> <em>(self, propname, value)</em> <strong>-></strong> <tt class="xref py py-class docutils literal"><span class="pre">DbData</span></tt></p>
<blockquote>
<div><blockquote>
<div><p>Get a (list) property(ies) for an attribute.</p>
<p>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</p>
<p>Note: for cases 3, 4 and 5 the ‘value’ parameter if given, is IGNORED.</p>
<p>If value is given it must be a PyTango.DbData that will be filled with the
property values</p>
</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">propname:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) property(ies) name(s)</td>
</tr>
<tr class="field"><th class="field-name">value:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">PyTango.DbData</span></tt>) (optional, default is None meaning that the
method will create internally a PyTango.DbData and return
it filled with the property values</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">(<tt class="xref py py-class docutils literal"><span class="pre">DbData</span></tt>) 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</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.NonDbDevice" title="PyTango.NonDbDevice"><tt class="xref py py-class docutils literal"><span class="pre">NonDbDevice</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a> (with database),
<a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a> (with database),
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from database device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.get_transparency_reconnection">
<tt class="descname">get_transparency_reconnection</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.get_transparency_reconnection" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().get_transparency_reconnection(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.get_transparency_reconnection(...):</p>
<blockquote>
<div><p>get_transparency_reconnection(self) -> bool</p>
<blockquote>
<div><blockquote>
<div>Returns the device transparency reconnection flag.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) True if transparency reconnection is set
or False otherwise</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.history">
<tt class="descname">history</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.history" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().attribute_history(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.attribute_history(...):</p>
<blockquote>
<div><p>attribute_history(self, attr_name, depth, extract_as=ExtractAs.Numpy) -> sequence<DeviceAttributeHistory></p>
<blockquote>
<div><blockquote>
<div>Retrieve attribute history from the attribute polling buffer. See
chapter on Advanced Feature for all details regarding polling</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) Attribute name.</td>
</tr>
<tr class="field"><th class="field-name">depth:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) The wanted history depth.</td>
</tr>
<tr class="field"><th class="field-name">extract_as:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">ExtractAs</span></tt>)</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">This method returns a vector of DeviceAttributeHistory types.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.NonSupportedFeature" title="PyTango.NonSupportedFeature"><tt class="xref py py-class docutils literal"><span class="pre">NonSupportedFeature</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.is_event_queue_empty">
<tt class="descname">is_event_queue_empty</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.is_event_queue_empty" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().is_event_queue_empty(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.is_event_queue_empty(...):</p>
<blockquote>
<div><p>is_event_queue_empty(self, event_id) -> bool</p>
<blockquote>
<div><p>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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">event_id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) event identifier</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">(<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) True if queue is empty or False otherwise</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.EventSystemFailed" title="PyTango.EventSystemFailed"><tt class="xref py py-class docutils literal"><span class="pre">EventSystemFailed</span></tt></a></p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.is_polled">
<tt class="descname">is_polled</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.is_polled" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().is_attribute_polled(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.is_attribute_polled(...):</p>
<blockquote>
<div><p>is_attribute_polled(self, attr_name) -> bool</p>
<blockquote>
<div><blockquote>
<div>True if the attribute is polled.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) attribute name</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">boolean value</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.name">
<tt class="descname">name</tt><big>(</big><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.name" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>name</strong> <em>(self)</em> <strong>-></strong> <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
<blockquote>
<div><blockquote>
<div>Returns the attribute name</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) with the attribute name</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.ping">
<tt class="descname">ping</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.ping" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().ping(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.ping(...):</p>
<blockquote>
<div><p>ping(self) -> int</p>
<blockquote>
<div><blockquote>
<div>A method which sends a ping to the device</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) time elapsed in milliseconds</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">exception</span></tt> if device is not alive</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.poll">
<tt class="descname">poll</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.poll" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().poll_attribute(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.poll_attribute(...):</p>
<blockquote>
<div><p>poll_attribute(self, attr_name, period) -> None</p>
<blockquote>
<div><blockquote>
<div>Add an attribute to the list of polled attributes.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) attribute name</td>
</tr>
<tr class="field"><th class="field-name">period:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) polling period in milliseconds</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.put_property">
<tt class="descname">put_property</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.put_property" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>put_property</strong> <em>(self, value)</em> <strong>-></strong> <tt class="xref py py-class xref docutils literal"><span class="pre">None</span></tt></p>
<blockquote>
<div><blockquote>
<div>Insert or update a list of properties for this attribute.
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</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">value:</th><td class="field-body">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</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device (DB_SQLError)</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.read">
<tt class="descname">read</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.read" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().read_attribute(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.read_attribute(...):</p>
<blockquote>
<div><p>read_attribute(self, attr_name, extract_as=ExtractAs.Numpy) -> DeviceAttribute</p>
<blockquote>
<div><blockquote>
<div>Read a single attribute.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) The name of the attribute to read.</td>
</tr>
<tr class="field"><th class="field-name">extract_as:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">ExtractAs</span></tt>) Defaults to numpy.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">(<a class="reference internal" href="miscellaneous.html#PyTango.DeviceAttribute" title="PyTango.DeviceAttribute"><tt class="xref py py-class docutils literal"><span class="pre">DeviceAttribute</span></tt></a>)</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p class="versionchanged">
<span class="versionmodified">Changed in version 7.1.4: </span>For <tt class="xref py py-class docutils literal"><span class="pre">DevEncoded</span></tt> attributes, before it was returning a <a class="reference internal" href="miscellaneous.html#PyTango.DeviceAttribute" title="PyTango.DeviceAttribute"><tt class="xref py py-class docutils literal"><span class="pre">DeviceAttribute</span></tt></a>.value
as a tuple <strong>(format<str>, data<str>)</strong> no matter what was the <em>extract_as</em>
value was. Since 7.1.4, it returns a <strong>(format<str>, data<buffer>)</strong>
unless <em>extract_as</em> is String, in which case it returns
<strong>(format<str>, data<str>)</strong>.</p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.read_asynch">
<tt class="descname">read_asynch</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.read_asynch" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().read_attribute_asynch(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.read_attribute_asynch(...):</p>
<blockquote>
<div><p>read_attribute_asynch( self, attr_name) -> int
read_attribute_asynch( self, attr_name, callback) -> None</p>
<blockquote>
<div><blockquote>
<div>Shortcut to self.read_attributes_asynch([attr_name], cb)</div></blockquote>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.read_reply">
<tt class="descname">read_reply</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.read_reply" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().read_attribute_reply(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.read_attribute_reply(...):</p>
<blockquote>
<div><p>read_attribute_reply( self, id, extract_as) -> int
read_attribute_reply( self, id, timeout, extract_as) -> None</p>
<blockquote>
<div><blockquote>
<div>Shortcut to self.read_attributes_reply()[0]</div></blockquote>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.set_config">
<tt class="descname">set_config</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.set_config" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().set_attribute_config(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.set_attribute_config(...):</p>
<blockquote>
<div><p>set_attribute_config( self, attr_info) -> None</p>
<blockquote>
<div><blockquote>
<div>Change the attribute configuration for the specified attribute</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_info:</th><td class="field-body">(<a class="reference internal" href="miscellaneous.html#PyTango.AttributeInfo" title="PyTango.AttributeInfo"><tt class="xref py py-class docutils literal"><span class="pre">AttributeInfo</span></tt></a>) attribute information</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>set_attribute_config( self, attr_info_ex) -> None</p>
<blockquote>
<div><blockquote>
<div>Change the extended attribute configuration for the specified attribute</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_info_ex:</th><td class="field-body">(<a class="reference internal" href="miscellaneous.html#PyTango.AttributeInfoEx" title="PyTango.AttributeInfoEx"><tt class="xref py py-class docutils literal"><span class="pre">AttributeInfoEx</span></tt></a>) extended attribute information</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>set_attribute_config( self, attr_info) -> None</p>
<blockquote>
<div><blockquote>
<div>Change the attributes configuration for the specified attributes</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_info:</th><td class="field-body">(sequence<<a class="reference internal" href="miscellaneous.html#PyTango.AttributeInfo" title="PyTango.AttributeInfo"><tt class="xref py py-class docutils literal"><span class="pre">AttributeInfo</span></tt></a>>) attributes information</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>set_attribute_config( self, attr_info_ex) -> None</p>
<blockquote>
<div><blockquote>
<div>Change the extended attributes configuration for the specified attributes</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_info_ex:</th><td class="field-body">(sequence<<tt class="xref py py-class docutils literal"><span class="pre">AttributeInfoListEx</span></tt>>) extended
attributes information</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.set_transparency_reconnection">
<tt class="descname">set_transparency_reconnection</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.set_transparency_reconnection" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().set_transparency_reconnection(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.set_transparency_reconnection(...):</p>
<blockquote>
<div><p>set_transparency_reconnection(self, yesno) -> None</p>
<blockquote>
<div><blockquote>
<div>Set the device transparency reconnection flag</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body">” - val : (bool) True to set transparency reconnection
” or False otherwise</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.state">
<tt class="descname">state</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.state" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().state(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.state(...):</p>
<blockquote>
<div><p>state(self) -> DevState</p>
<blockquote>
<div><blockquote>
<div>A method which returns the state of the device.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">(<a class="reference internal" href="other.html#PyTango.DevState" title="PyTango.DevState"><tt class="xref py py-class docutils literal"><span class="pre">DevState</span></tt></a>) constant</p>
</td>
</tr>
<tr class="field"><th class="field-name">Example:</th><td class="field-body"><div class="first last highlight-python"><div class="highlight"><pre><span class="n">dev_st</span> <span class="o">=</span> <span class="n">dev</span><span class="o">.</span><span class="n">state</span><span class="p">()</span>
<span class="k">if</span> <span class="n">dev_st</span> <span class="o">==</span> <span class="n">DevState</span><span class="o">.</span><span class="n">ON</span> <span class="p">:</span> <span class="o">...</span>
</pre></div>
</div>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.status">
<tt class="descname">status</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.status" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().status(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.status(...):</p>
<blockquote>
<div><p>status(self) -> str</p>
<blockquote>
<div><blockquote>
<div>A method which returns the status of the device as a string.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) describing the device status</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.stop_poll">
<tt class="descname">stop_poll</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.stop_poll" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().stop_poll_attribute(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.stop_poll_attribute(...):</p>
<blockquote>
<div><p>stop_poll_attribute(self, attr_name) -> None</p>
<blockquote>
<div><blockquote>
<div>Remove an attribute from the list of polled attributes.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) attribute name</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.subscribe_event">
<tt class="descname">subscribe_event</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.subscribe_event" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().subscribe_event(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.subscribe_event(...):</p>
<blockquote>
<div><p>subscribe_event(self, attr_name, event, callback, filters=[], stateless=False, extract_as=Numpy) -> int</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) The device attribute name which will be sent
as an event e.g. “current”.</td>
</tr>
<tr class="field"><th class="field-name">event_type:</th><td class="field-body">(<a class="reference internal" href="other.html#PyTango.EventType" title="PyTango.EventType"><tt class="xref py py-class docutils literal"><span class="pre">EventType</span></tt></a>) 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</td>
</tr>
<tr class="field"><th class="field-name">callback:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">callable</span></tt>) Is any callable object or an object with a
callable “push_event” method.</td>
</tr>
<tr class="field"><th class="field-name">filters:</th><td class="field-body">(sequence<<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>>) A variable list of name,value pairs
which define additional filters for events.</td>
</tr>
<tr class="field"><th class="field-name">stateless:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) 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</td>
</tr>
<tr class="field"><th class="field-name">extract_as:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">ExtractAs</span></tt>)</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">An event id which has to be specified when unsubscribing
from this event.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.EventSystemFailed" title="PyTango.EventSystemFailed"><tt class="xref py py-class docutils literal"><span class="pre">EventSystemFailed</span></tt></a></p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>subscribe_event(self, attr_name, event, queuesize, filters=[], stateless=False ) -> int</p>
<blockquote>
<div><p>The client call to subscribe for event reception in the pull model.
Instead of a <tt class="xref py py-class docutils literal"><span class="pre">callback</span></tt> 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:</p>
<blockquote>
<div><ul class="simple">
<li>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.</li>
<li>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.</li>
<li>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.</li>
</ul>
</div></blockquote>
<p>All other parameters are similar to the descriptions given in the
other subscribe_event() version.</p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.unsubscribe_event">
<tt class="descname">unsubscribe_event</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.unsubscribe_event" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().unsubscribe_event(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.unsubscribe_event(...):</p>
<blockquote>
<div><p>unsubscribe_event(self, event_id) -> None</p>
<blockquote>
<div><blockquote>
<div>Unsubscribes a client from receiving the event specified by event_id.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">event_id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) 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.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.EventSystemFailed" title="PyTango.EventSystemFailed"><tt class="xref py py-class docutils literal"><span class="pre">EventSystemFailed</span></tt></a></p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.write">
<tt class="descname">write</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.write" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().write_attribute(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.write_attribute(...):</p>
<blockquote>
<div><p>write_attribute(self, attr_name, value) -> None
write_attribute(self, attr_info, value) -> None</p>
<blockquote>
<div><blockquote>
<div>Write a single attribute.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">attr_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) The name of the attribute to write.</td>
</tr>
<tr class="field"><th class="field-name">attr_info:</th><td class="field-body">(<a class="reference internal" href="miscellaneous.html#PyTango.AttributeInfo" title="PyTango.AttributeInfo"><tt class="xref py py-class docutils literal"><span class="pre">AttributeInfo</span></tt></a>)</td>
</tr>
<tr class="field"><th class="field-name">value:</th><td class="field-body">The value. For non SCALAR attributes it may be any sequence of sequences.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DeviceUnlocked" title="PyTango.DeviceUnlocked"><tt class="xref py py-class docutils literal"><span class="pre">DeviceUnlocked</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.write_asynch">
<tt class="descname">write_asynch</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.write_asynch" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().write_attribute_asynch(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.write_attribute_asynch(...):</p>
<blockquote>
<div><p>write_attributes_asynch( self, values) -> int
write_attributes_asynch( self, values, callback) -> None</p>
<blockquote>
<div><blockquote>
<div>Shortcut to self.write_attributes_asynch([attr_name, value], cb)</div></blockquote>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.write_read">
<tt class="descname">write_read</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.write_read" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().write_read_attribute(self.name(), ...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.write_read_attribute(...):</p>
<blockquote>
<div><p>write_read_attribute(self, attr_name, value, extract_as=ExtractAs.Numpy) -> DeviceAttribute</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body">see write_attribute(attr_name, value)</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body">A PyTango.DeviceAttribute object.</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><a class="reference internal" href="../exception.html#PyTango.ConnectionFailed" title="PyTango.ConnectionFailed"><tt class="xref py py-class docutils literal"><span class="pre">ConnectionFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DeviceUnlocked" title="PyTango.DeviceUnlocked"><tt class="xref py py-class docutils literal"><span class="pre">DeviceUnlocked</span></tt></a>,
<a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device, <a class="reference internal" href="../exception.html#PyTango.WrongData" title="PyTango.WrongData"><tt class="xref py py-class docutils literal"><span class="pre">WrongData</span></tt></a></td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.AttributeProxy.write_reply">
<tt class="descname">write_reply</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#PyTango.AttributeProxy.write_reply" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>This method is a simple way to do:</dt>
<dd>self.get_device_proxy().write_attribute_reply(...)</dd>
</dl>
<p>For convenience, here is the documentation of DeviceProxy.write_attribute_reply(...):</p>
<blockquote>
<div><p>write_attribute_reply(self, id) -> None</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the asynchronous call identifier.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.AsynCall" title="PyTango.AsynCall"><tt class="xref py py-class docutils literal"><span class="pre">AsynCall</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.AsynReplyNotArrived" title="PyTango.AsynReplyNotArrived"><tt class="xref py py-class docutils literal"><span class="pre">AsynReplyNotArrived</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device.</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
<p>write_attribute_reply(self, id, timeout) -> None</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the asynchronous call identifier.</td>
</tr>
<tr class="field"><th class="field-name">timeout:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the timeout</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.AsynCall" title="PyTango.AsynCall"><tt class="xref py py-class docutils literal"><span class="pre">AsynCall</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.AsynReplyNotArrived" title="PyTango.AsynReplyNotArrived"><tt class="xref py py-class docutils literal"><span class="pre">AsynReplyNotArrived</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device.</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
<p>write_attributes_reply(self, id) -> None</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the asynchronous call identifier.</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.AsynCall" title="PyTango.AsynCall"><tt class="xref py py-class docutils literal"><span class="pre">AsynCall</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.AsynReplyNotArrived" title="PyTango.AsynReplyNotArrived"><tt class="xref py py-class docutils literal"><span class="pre">AsynReplyNotArrived</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device.</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
<p>write_attributes_reply(self, id, timeout) -> None</p>
<blockquote>
<div><blockquote>
<div>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.</div></blockquote>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><table class="first docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">id:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the asynchronous call identifier.</td>
</tr>
<tr class="field"><th class="field-name">timeout:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the timeout</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="../exception.html#PyTango.AsynCall" title="PyTango.AsynCall"><tt class="xref py py-class docutils literal"><span class="pre">AsynCall</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.AsynReplyNotArrived" title="PyTango.AsynReplyNotArrived"><tt class="xref py py-class docutils literal"><span class="pre">AsynReplyNotArrived</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.CommunicationFailed" title="PyTango.CommunicationFailed"><tt class="xref py py-class docutils literal"><span class="pre">CommunicationFailed</span></tt></a>, <a class="reference internal" href="../exception.html#PyTango.DevFailed" title="PyTango.DevFailed"><tt class="xref py py-class docutils literal"><span class="pre">DevFailed</span></tt></a> from device.</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</div></blockquote>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="group.html" title="Group"
>next</a> |</li>
<li class="right" >
<a href="device_proxy.html" title="DeviceProxy"
>previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../start.html">getting started</a>| </li>
<li><a href="../quicktour.html">quick tour</a>| </li>
<li><a href="../contents.html">documentation </a> »</li>
<li><a href="../contents.html" >Contents</a> »</li>
<li><a href="../api.html" >PyTango API</a> »</li>
<li><a href="index.html" >The Tango Device Python API</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright Except where otherwise noted, content on this site is
licensed under a Creative Commons Attribution 3.0 License.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
</div>
</body>
</html>
|