/usr/share/doc/python-pytango-doc/html/server_api/util.html is in python-pytango-doc 8.1.5-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 | <!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>Util — PyTango 8.1.5 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: '8.1.5',
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="shortcut icon" href="../_static/logo.ico"/>
<link rel="top" title="PyTango 8.1.5 documentation" href="../index.html" />
<link rel="up" title="Server API" href="index.html" />
<link rel="next" title="Database API" href="../database.html" />
<link rel="prev" title="Attribute classes" href="attribute.html" />
</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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../database.html" title="Database API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="attribute.html" title="Attribute classes"
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="../howto.html">how to</a>| </li>
<li><a href="../faq.html">FAQ</a>| </li>
<li><a href="../contents.html">documentation </a> »</li>
<li><a href="../api.html" >PyTango API</a> »</li>
<li><a href="index.html" accesskey="U">Server API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../contents.html">
<img class="logo" src="../_static/logo.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="attribute.html"
title="previous chapter">Attribute classes</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../database.html"
title="next chapter">Database API</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/server_api/util.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="util">
<h1>Util<a class="headerlink" href="#util" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="PyTango.Util">
<em class="property">class </em><tt class="descclassname">PyTango.</tt><tt class="descname">Util</tt><big>(</big><em>args</em><big>)</big><a class="headerlink" href="#PyTango.Util" title="Permalink to this definition">¶</a></dt>
<dd><p>This class is a used to store TANGO device server process data and to
provide the user with a set of utilities method.</p>
<p>This class is implemented using the singleton design pattern.
Therefore a device server process can have only one instance of this
class and its constructor is not public. Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">util</span> <span class="o">=</span> <span class="n">PyTango</span><span class="o">.</span><span class="n">Util</span><span class="o">.</span><span class="n">instance</span><span class="p">()</span>
<span class="k">print</span><span class="p">(</span><span class="n">util</span><span class="o">.</span><span class="n">get_host_name</span><span class="p">())</span>
</pre></div>
</div>
<dl class="method">
<dt id="PyTango.Util.add_Cpp_TgClass">
<tt class="descname">add_Cpp_TgClass</tt><big>(</big><em>device_class_name</em>, <em>tango_device_class_name</em><big>)</big><a class="headerlink" href="#PyTango.Util.add_Cpp_TgClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a new C++ tango class.</p>
<p>If there is a shared library file called MotorClass.so which
contains a MotorClass class and a _create_MotorClass_class method. Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">util</span><span class="o">.</span><span class="n">add_Cpp_TgClass</span><span class="p">(</span><span class="s">'MotorClass'</span><span class="p">,</span> <span class="s">'Motor'</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">the parameter ‘device_class_name’ must match the shared
library name.</p>
</div>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 7.1.2: </span>Use <a class="reference internal" href="#PyTango.Util.add_class" title="PyTango.Util.add_class"><tt class="xref py py-meth docutils literal"><span class="pre">PyTango.Util.add_class()</span></tt></a> instead.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.add_TgClass">
<tt class="descname">add_TgClass</tt><big>(</big><em>klass_device_class</em>, <em>klass_device</em>, <em>device_class_name=None</em><big>)</big><a class="headerlink" href="#PyTango.Util.add_TgClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a new python tango class. Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">util</span><span class="o">.</span><span class="n">add_TgClass</span><span class="p">(</span><span class="n">MotorClass</span><span class="p">,</span> <span class="n">Motor</span><span class="p">)</span>
<span class="n">util</span><span class="o">.</span><span class="n">add_TgClass</span><span class="p">(</span><span class="n">MotorClass</span><span class="p">,</span> <span class="n">Motor</span><span class="p">,</span> <span class="s">'Motor'</span><span class="p">)</span> <span class="c"># equivalent to previous line</span>
</pre></div>
</div>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 7.1.2: </span>Use <a class="reference internal" href="#PyTango.Util.add_class" title="PyTango.Util.add_class"><tt class="xref py py-meth docutils literal"><span class="pre">PyTango.Util.add_class()</span></tt></a> instead.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.add_class">
<tt class="descname">add_class</tt><big>(</big><em>self</em>, <em>args</em>, <em>language="python"</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.add_class" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><p>Register a new tango class (‘python’ or ‘c++’).</p>
<p>If language is ‘python’ then args must be the same as
<a class="reference internal" href="#PyTango.Util.add_TgClass" title="PyTango.Util.add_TgClass"><tt class="xref py py-meth docutils literal"><span class="pre">PyTango.Util.add_TgClass()</span></tt></a>. Otherwise, args should be the ones
in <a class="reference internal" href="#PyTango.Util.add_Cpp_TgClass" title="PyTango.Util.add_Cpp_TgClass"><tt class="xref py py-meth docutils literal"><span class="pre">PyTango.Util.add_Cpp_TgClass()</span></tt></a>. Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">util</span><span class="o">.</span><span class="n">add_class</span><span class="p">(</span><span class="n">MotorClass</span><span class="p">,</span> <span class="n">Motor</span><span class="p">)</span>
<span class="n">util</span><span class="o">.</span><span class="n">add_class</span><span class="p">(</span><span class="s">'CounterClass'</span><span class="p">,</span> <span class="s">'Counter'</span><span class="p">,</span> <span class="n">language</span><span class="o">=</span><span class="s">'c++'</span><span class="p">)</span>
</pre></div>
</div>
</div></blockquote>
<p><em>New in PyTango 7.1.2</em></p>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.connect_db">
<tt class="descname">connect_db</tt><big>(</big><em>self</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.connect_db" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Connect the process to the TANGO database.
If the connection to the database failed, a message is
displayed on the screen and the process is aborted</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.create_device">
<tt class="descname">create_device</tt><big>(</big><em>self</em>, <em>klass_name</em>, <em>device_name</em>, <em>alias=None</em>, <em>cb=None</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.create_device" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><p>Creates a new device of the given class in the database, creates a new
DeviceImpl for it and calls init_device (just like it is done for
existing devices when the DS starts up)</p>
<p>An optional parameter callback is called AFTER the device is
registered in the database and BEFORE the init_device for the
newly created device is called</p>
<dl class="docutils">
<dt>Throws PyTango.DevFailed:</dt>
<dd><ul class="first last simple">
<li>the device name exists already or</li>
<li>the given class is not registered for this DS.</li>
<li>the cb is not a callable</li>
</ul>
</dd>
</dl>
</div></blockquote>
<p><em>New in PyTango 7.1.2</em></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd 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-odd field"><th class="field-name">klass_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) the device class name</td>
</tr>
<tr class="field-even field"><th class="field-name">device_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) the device name</td>
</tr>
<tr class="field-odd field"><th class="field-name">alias:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) optional alias. Default value is None meaning do not create device alias</td>
</tr>
<tr class="field-even field"><th class="field-name">cb:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">callable</span></tt>) a callback that is called AFTER the device is registered
in the database and BEFORE the init_device for the newly created
device is called. Typically you may want to put device and/or attribute
properties in the database here. The callback must receive a parameter:
device name (str). Default value is None meaning no callback</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.delete_device">
<tt class="descname">delete_device</tt><big>(</big><em>self</em>, <em>klass_name</em>, <em>device_name</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.delete_device" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><p>Deletes an existing device from the database and from this running
server</p>
<dl class="docutils">
<dt>Throws PyTango.DevFailed:</dt>
<dd><ul class="first last simple">
<li>the device name doesn’t exist in the database</li>
<li>the device name doesn’t exist in this DS.</li>
</ul>
</dd>
</dl>
</div></blockquote>
<p><em>New in PyTango 7.1.2</em></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd 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-odd field"><th class="field-name">klass_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) the device class name</td>
</tr>
<tr class="field-even field"><th class="field-name">device_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) the device name</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_class_list">
<tt class="descname">get_class_list</tt><big>(</big><em>self</em><big>)</big> → seq<DeviceClass><a class="headerlink" href="#PyTango.Util.get_class_list" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div>Returns a list of objects of inheriting from DeviceClass</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">(<a class="reference internal" href="device_class.html#PyTango.DeviceClass" title="PyTango.DeviceClass"><tt class="xref py py-class docutils literal"><span class="pre">seq</span></tt></a>) a list of objects of inheriting from DeviceClass</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_database">
<tt class="descname">get_database</tt><big>(</big><em>self</em><big>)</big> → Database<a class="headerlink" href="#PyTango.Util.get_database" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get a reference to the TANGO database object</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">(<a class="reference internal" href="../database.html#PyTango.Database" title="PyTango.Database"><tt class="xref py py-class docutils literal"><span class="pre">Database</span></tt></a>) the database</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_device_by_name">
<tt class="descname">get_device_by_name</tt><big>(</big><em>self</em>, <em>dev_name</em><big>)</big> → DeviceImpl<a class="headerlink" href="#PyTango.Util.get_device_by_name" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get a device reference from its 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-odd 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-odd field"><th class="field-name">dev_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) The TANGO device name</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">(<a class="reference internal" href="device.html#PyTango.DeviceImpl" title="PyTango.DeviceImpl"><tt class="xref py py-class docutils literal"><span class="pre">DeviceImpl</span></tt></a>) The device reference</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_device_list">
<tt class="descname">get_device_list</tt><big>(</big><em>self</em><big>)</big> → sequence<DeviceImpl><a class="headerlink" href="#PyTango.Util.get_device_list" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get device list from name.
It is possible to use a wild card (‘*’) in the name parameter
(e.g. “*”, “/tango/tangotest/n*”, ...)</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">(sequence<<a class="reference internal" href="device.html#PyTango.DeviceImpl" title="PyTango.DeviceImpl"><tt class="xref py py-class docutils literal"><span class="pre">DeviceImpl</span></tt></a>>) the list of device objects</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_device_list_by_class">
<tt class="descname">get_device_list_by_class</tt><big>(</big><em>self</em>, <em>class_name</em><big>)</big> → sequence<DeviceImpl><a class="headerlink" href="#PyTango.Util.get_device_list_by_class" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the list of device references for a given TANGO class.
Return the list of references for all devices served by one implementation
of the TANGO device pattern implemented in the process.</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-odd 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-odd field"><th class="field-name">class_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) The TANGO device class name</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">(sequence<<a class="reference internal" href="device.html#PyTango.DeviceImpl" title="PyTango.DeviceImpl"><tt class="xref py py-class docutils literal"><span class="pre">DeviceImpl</span></tt></a>>) The device reference list</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_ds_exec_name">
<tt class="descname">get_ds_exec_name</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.Util.get_ds_exec_name" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get a COPY of the device server executable 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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) a COPY of the device server executable name.</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 3.0.4</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_ds_inst_name">
<tt class="descname">get_ds_inst_name</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.Util.get_ds_inst_name" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get a COPY of the device server instance 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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) a COPY of the device server instance name.</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 3.0.4</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_ds_name">
<tt class="descname">get_ds_name</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.Util.get_ds_name" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the device server name.
The device server name is the <device server executable name>/<the device server instance 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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) device server name</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 3.0.4</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_dserver_device">
<tt class="descname">get_dserver_device</tt><big>(</big><em>self</em><big>)</big> → DServer<a class="headerlink" href="#PyTango.Util.get_dserver_device" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get a reference to the dserver device attached to the device server process</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">(<a class="reference internal" href="device.html#PyTango.DServer" title="PyTango.DServer"><tt class="xref py py-class docutils literal"><span class="pre">DServer</span></tt></a>) A reference to the dserver device</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
<p><strong>get_dserver_device</strong> <em>(self)</em> <strong>-></strong> <a class="reference internal" href="device.html#PyTango.DServer" title="PyTango.DServer"><tt class="xref py py-class docutils literal"><span class="pre">DServer</span></tt></a></p>
<blockquote>
<div><blockquote>
<div>Get a reference to the dserver device attached to the device server process.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">(<a class="reference internal" href="device.html#PyTango.DServer" title="PyTango.DServer"><tt class="xref py py-class docutils literal"><span class="pre">DServer</span></tt></a>) the dserver device attached to the device server process</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_host_name">
<tt class="descname">get_host_name</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.Util.get_host_name" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the host name where the device server process is running.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) the host name where the device server process is running</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 3.0.4</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_pid">
<tt class="descname">get_pid</tt><big>(</big><em>self</em><big>)</big> → TangoSys_Pid<a class="headerlink" href="#PyTango.Util.get_pid" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the device server process identifier.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) the device server process identifier</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_pid_str">
<tt class="descname">get_pid_str</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.Util.get_pid_str" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the device server process identifier 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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) the device server process identifier as a string</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 3.0.4</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_polling_threads_pool_size">
<tt class="descname">get_polling_threads_pool_size</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#PyTango.Util.get_polling_threads_pool_size" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the polling threads pool size.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) the maximun number of threads in the polling threads pool</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_serial_model">
<tt class="descname">get_serial_model</tt><big>(</big><em>self</em><big>)</big> → SerialModel<a class="headerlink" href="#PyTango.Util.get_serial_model" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the serialization model.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">(<a class="reference internal" href="../client_api/other.html#PyTango.SerialModel" title="PyTango.SerialModel"><tt class="xref py py-class docutils literal"><span class="pre">SerialModel</span></tt></a>) the serialization model</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_server_version">
<tt class="descname">get_server_version</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.Util.get_server_version" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the device server version.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) the device server version.</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_sub_dev_diag">
<tt class="descname">get_sub_dev_diag</tt><big>(</big><em>self</em><big>)</big> → SubDevDiag<a class="headerlink" href="#PyTango.Util.get_sub_dev_diag" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the internal sub device manager</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">SubDevDiag</span></tt>) the sub device manager</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_tango_lib_release">
<tt class="descname">get_tango_lib_release</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#PyTango.Util.get_tango_lib_release" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the TANGO library version number.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) The Tango library release number coded in
3 digits (for instance 550,551,552,600,....)</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_trace_level">
<tt class="descname">get_trace_level</tt><big>(</big><em>self</em><big>)</big> → int<a class="headerlink" href="#PyTango.Util.get_trace_level" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the process trace level.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) the process trace level.</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.get_version_str">
<tt class="descname">get_version_str</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.Util.get_version_str" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the IDL TANGO version.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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>) the IDL TANGO version.</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 3.0.4</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.is_device_restarting">
<tt class="descname">is_device_restarting</tt><big>(</big><em>self</em>, <em>(str)dev_name</em><big>)</big> → bool<a class="headerlink" href="#PyTango.Util.is_device_restarting" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Check if the device is actually restarted by the device server
process admin device with its DevRestart command</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">dev_name : (str) device name</td>
</tr>
<tr class="field-even 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 the device is restarting.</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 8.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.is_svr_shutting_down">
<tt class="descname">is_svr_shutting_down</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#PyTango.Util.is_svr_shutting_down" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Check if the device server process is in its shutting down sequence</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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 the server is in its shutting down phase.</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 8.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.is_svr_starting">
<tt class="descname">is_svr_starting</tt><big>(</big><em>self</em><big>)</big> → bool<a class="headerlink" href="#PyTango.Util.is_svr_starting" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Check if the device server process is in its starting phase</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even 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 the server is in its starting phase</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 8.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.reset_filedatabase">
<tt class="descname">reset_filedatabase</tt><big>(</big><em>self</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.reset_filedatabase" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Reread the file database</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
<p><strong>reset_filedatabase</strong> <em>(self)</em> <strong>-></strong> <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt></p>
<blockquote>
<div><blockquote>
<div>Reread the file database.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.server_init">
<tt class="descname">server_init</tt><big>(</big><em>self</em>, <em>with_window = False</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.server_init" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Initialize all the device server pattern(s) embedded in a device server process.</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-odd 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-odd field"><th class="field-name">with_window:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) default value is False</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><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> If the device pattern initialistaion failed</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.server_run">
<tt class="descname">server_run</tt><big>(</big><em>self</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.server_run" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Run the CORBA event loop.
This method runs the CORBA event loop. For UNIX or Linux operating system,
this method does not return. For Windows in a non-console mode, this method
start a thread which enter the CORBA event loop.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.server_set_event_loop">
<tt class="descname">server_set_event_loop</tt><big>(</big><em>self</em>, <em>event_loop</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.server_set_event_loop" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><p>This method registers an event loop function in a Tango server.
This function will be called by the process main thread in an infinite loop
The process will not use the classical ORB blocking event loop.
It is the user responsability to code this function in a way that it implements
some kind of blocking in order not to load the computer CPU. The following
piece of code is an example of how you can use this feature:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">_LOOP_NB</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">def</span> <span class="nf">looping</span><span class="p">():</span>
<span class="k">global</span> <span class="n">_LOOP_NB</span>
<span class="k">print</span> <span class="s">"looping"</span><span class="p">,</span> <span class="n">_LOOP_NB</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">0.1</span><span class="p">)</span>
<span class="n">_LOOP_NB</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">_LOOP_NB</span> <span class="o">></span> <span class="mi">100</span>
<span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
<span class="n">py</span> <span class="o">=</span> <span class="n">PyTango</span><span class="o">.</span><span class="n">Util</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span>
<span class="c"># ...</span>
<span class="n">U</span> <span class="o">=</span> <span class="n">PyTango</span><span class="o">.</span><span class="n">Util</span><span class="o">.</span><span class="n">instance</span><span class="p">()</span>
<span class="n">U</span><span class="o">.</span><span class="n">server_set_event_loop</span><span class="p">(</span><span class="n">looping</span><span class="p">)</span>
<span class="n">U</span><span class="o">.</span><span class="n">server_init</span><span class="p">()</span>
<span class="n">U</span><span class="o">.</span><span class="n">server_run</span><span class="p">()</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 8.1.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.set_polling_threads_pool_size">
<tt class="descname">set_polling_threads_pool_size</tt><big>(</big><em>self</em>, <em>thread_nb</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.set_polling_threads_pool_size" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Set the polling threads pool size.</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-odd 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-odd field"><th class="field-name">thread_nb:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the maximun number of threads in the polling threads pool</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.set_serial_model">
<tt class="descname">set_serial_model</tt><big>(</big><em>self</em>, <em>ser</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.set_serial_model" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Set the serialization model.</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-odd 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-odd field"><th class="field-name">ser:</th><td class="field-body">(<a class="reference internal" href="../client_api/other.html#PyTango.SerialModel" title="PyTango.SerialModel"><tt class="xref py py-class docutils literal"><span class="pre">SerialModel</span></tt></a>) the new serialization model. The serialization model must
be one of BY_DEVICE, BY_CLASS, BY_PROCESS or NO_SYNC</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.set_server_version">
<tt class="descname">set_server_version</tt><big>(</big><em>self</em>, <em>vers</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.set_server_version" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Set the device server version.</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-odd 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-odd field"><th class="field-name">vers:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) the device server version</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.set_trace_level">
<tt class="descname">set_trace_level</tt><big>(</big><em>self</em>, <em>level</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.set_trace_level" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Set the process trace level.</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-odd 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-odd field"><th class="field-name">level:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) the new process level</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.trigger_attr_polling">
<tt class="descname">trigger_attr_polling</tt><big>(</big><em>self</em>, <em>dev</em>, <em>name</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.trigger_attr_polling" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Trigger polling for polled attribute.
This method send the order to the polling thread to poll one object registered
with an update period defined as “externally triggerred”</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-odd 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-odd field"><th class="field-name">dev:</th><td class="field-body">(<a class="reference internal" href="device.html#PyTango.DeviceImpl" title="PyTango.DeviceImpl"><tt class="xref py py-class docutils literal"><span class="pre">DeviceImpl</span></tt></a>) the TANGO device</td>
</tr>
<tr class="field-even 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>) the attribute name which must be polled</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return:</th><td class="field-body"><p class="first last">None</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.trigger_cmd_polling">
<tt class="descname">trigger_cmd_polling</tt><big>(</big><em>self</em>, <em>dev</em>, <em>name</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.trigger_cmd_polling" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Trigger polling for polled command.
This method send the order to the polling thread to poll one object registered
with an update period defined as “externally triggerred”</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-odd 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-odd field"><th class="field-name">dev:</th><td class="field-body">(<a class="reference internal" href="device.html#PyTango.DeviceImpl" title="PyTango.DeviceImpl"><tt class="xref py py-class docutils literal"><span class="pre">DeviceImpl</span></tt></a>) the TANGO device</td>
</tr>
<tr class="field-even 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>) the command name which must be polled</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return:</th><td class="field-body"><p class="first">None</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><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> If the call failed</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.Util.unregister_server">
<tt class="descname">unregister_server</tt><big>(</big><em>self</em><big>)</big> → None<a class="headerlink" href="#PyTango.Util.unregister_server" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Unregister a device server process from the TANGO database.
If the database call fails, a message is displayed on the screen
and the process is aborted</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 7.0.0</em></p>
</div></blockquote>
<p><strong>unregister_server</strong> <em>(self)</em> <strong>-></strong> <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt></p>
<blockquote>
<div><blockquote>
<div>Unregister a device server process from the TANGO database.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body">None</td>
</tr>
<tr class="field-even field"><th class="field-name">Return:</th><td class="field-body">None</td>
</tr>
</tbody>
</table>
</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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../database.html" title="Database API"
>next</a> |</li>
<li class="right" >
<a href="attribute.html" title="Attribute classes"
>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="../howto.html">how to</a>| </li>
<li><a href="../faq.html">FAQ</a>| </li>
<li><a href="../contents.html">documentation </a> »</li>
<li><a href="../api.html" >PyTango API</a> »</li>
<li><a href="index.html" >Server 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-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>
|