/usr/share/doc/python-pytango-doc/html/server_api/device_class.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 | <!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>DeviceClass — 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="Logging decorators" href="logging.html" />
<link rel="prev" title="Device" href="device.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="logging.html" title="Logging decorators"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="device.html" title="Device"
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="device.html"
title="previous chapter">Device</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="logging.html"
title="next chapter">Logging decorators</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/server_api/device_class.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="deviceclass">
<h1>DeviceClass<a class="headerlink" href="#deviceclass" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="PyTango.DeviceClass">
<em class="property">class </em><tt class="descclassname">PyTango.</tt><tt class="descname">DeviceClass</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#PyTango.DeviceClass" title="Permalink to this definition">¶</a></dt>
<dd><p>Base class for all TANGO device-class class.
A TANGO device-class class is a class where is stored all
data/method common to all devices of a TANGO device class</p>
<dl class="method">
<dt id="PyTango.DeviceClass.add_wiz_class_prop">
<tt class="descname">add_wiz_class_prop</tt><big>(</big><em>self</em>, <em>str</em>, <em>str</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.add_wiz_class_prop" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>add_wiz_class_prop</strong> <em>(self, str, str, str)</em> <strong>-></strong> <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt></p>
<blockquote>
<div><blockquote>
<div>For internal usage only</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.DeviceClass.add_wiz_dev_prop">
<tt class="descname">add_wiz_dev_prop</tt><big>(</big><em>self</em>, <em>str</em>, <em>str</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.add_wiz_dev_prop" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>add_wiz_dev_prop</strong> <em>(self, str, str, str)</em> <strong>-></strong> <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt></p>
<blockquote>
<div><blockquote>
<div>For internal usage only</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.DeviceClass.create_device">
<tt class="descname">create_device</tt><big>(</big><em>self</em>, <em>device_name</em>, <em>alias=None</em>, <em>cb=None</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.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>
</div></blockquote>
<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>
<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">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-even 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-odd 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-even 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.DeviceClass.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.DeviceClass.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.DeviceClass.device_destroyer">
<tt class="descname">device_destroyer</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#PyTango.DeviceClass.device_destroyer" title="Permalink to this definition">¶</a></dt>
<dd><p>for internal usage only</p>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.device_factory">
<tt class="descname">device_factory</tt><big>(</big><em>device_list</em><big>)</big><a class="headerlink" href="#PyTango.DeviceClass.device_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>for internal usage only</p>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.device_name_factory">
<tt class="descname">device_name_factory</tt><big>(</big><em>self</em>, <em>dev_name_list</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.device_name_factory" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div>Create device(s) name list (for no database device server).
This method can be re-defined in DeviceClass sub-class for
device server started without database. Its rule is to
initialise class device name. The default method does nothing.</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_list:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">seq</span></tt>) sequence of devices to be filled</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>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.dyn_attr">
<tt class="descname">dyn_attr</tt><big>(</big><em>self</em>, <em>device_list</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.dyn_attr" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div>Default implementation does not do anything
Overwrite in order to provide dynamic 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-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">device_list:</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">seq</span></tt></a>) sequence of devices of this class</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>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.export_device">
<tt class="descname">export_device</tt><big>(</big><em>self</em>, <em>dev</em>, <em>corba_dev_name = 'Unused'</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.export_device" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>For internal usage only</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>) device object</td>
</tr>
<tr class="field-even field"><th class="field-name">corba_dev_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) CORBA device name. Default value is ‘Unused’</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.DeviceClass.get_cmd_by_name">
<tt class="descname">get_cmd_by_name</tt><big>(</big><em>self</em>, <em>(str)cmd_name</em><big>)</big> → PyTango.Command<a class="headerlink" href="#PyTango.DeviceClass.get_cmd_by_name" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get a reference to a command 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"><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">cmd_name:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) command 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">(<tt class="xref py py-class docutils literal"><span class="pre">PyTango.Command</span></tt>) PyTango.Command object</p>
</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 8.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.get_command_list">
<tt class="descname">get_command_list</tt><big>(</big><em>self</em><big>)</big> → sequence<PyTango.Command><a class="headerlink" href="#PyTango.DeviceClass.get_command_list" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Gets the list of PyTango.Command objects for this class</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<<tt class="xref py py-class docutils literal"><span class="pre">PyTango.Command</span></tt>>) list of PyTango.Command objects for this class</td>
</tr>
</tbody>
</table>
<p><em>New in PyTango 8.0.0</em></p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.get_cvs_location">
<tt class="descname">get_cvs_location</tt><big>(</big><em>self</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.get_cvs_location" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Gets the cvs localtion</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>) cvs location</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.get_cvs_tag">
<tt class="descname">get_cvs_tag</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.DeviceClass.get_cvs_tag" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Gets the cvs tag</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>) cvs tag</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.get_device_list">
<tt class="descname">get_device_list</tt><big>(</big><em>self</em><big>)</big> → sequence<PyTango.DeviceImpl><a class="headerlink" href="#PyTango.DeviceClass.get_device_list" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Gets the list of PyTango.DeviceImpl objects for this class</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">PyTango.DeviceImpl</span></tt></a>>) list of PyTango.DeviceImpl objects for this class</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.get_doc_url">
<tt class="descname">get_doc_url</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.DeviceClass.get_doc_url" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the TANGO device class documentation URL.</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 TANGO device type name</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.get_name">
<tt class="descname">get_name</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.DeviceClass.get_name" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Get the TANGO device class 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>) the TANGO device class name.</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.get_type">
<tt class="descname">get_type</tt><big>(</big><em>self</em><big>)</big> → str<a class="headerlink" href="#PyTango.DeviceClass.get_type" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Gets the TANGO device type 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>) the TANGO device type name</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.register_signal">
<tt class="descname">register_signal</tt><big>(</big><em>self</em>, <em>signo</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.register_signal" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>register_signal</strong> <em>(self, signo, own_handler=false)</em> <strong>-></strong> <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt></p>
<blockquote>
<div><blockquote>
<div>Register a signal.
Register this class as class to be informed when signal signo
is sent to to the device server process.
The second version of the method is available only under Linux.</div></blockquote>
<dl class="docutils">
<dt>Throws PyTango.DevFailed:</dt>
<dd><ul class="first last simple">
<li>if the signal number is out of range</li>
<li>if the operating system failed to register a signal for the process.</li>
</ul>
</dd>
</dl>
<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">signo:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) signal identifier</td>
</tr>
<tr class="field-even field"><th class="field-name">own_handler:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) true if you want the device signal handler
to be executed in its own handler instead of being
executed by the signal thread. If this parameter
is set to true, care should be taken on how the
handler is written. A default false value is provided</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.DeviceClass.set_type">
<tt class="descname">set_type</tt><big>(</big><em>self</em>, <em>dev_type</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.set_type" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Set the TANGO device type 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_type:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) the new TANGO device type 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">None</p>
</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="PyTango.DeviceClass.signal_handler">
<tt class="descname">signal_handler</tt><big>(</big><em>self</em>, <em>signo</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.signal_handler" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div><p>Signal handler.</p>
<p>The method executed when the signal arrived in the device server process.
This method is defined as virtual and then, can be redefined following
device class needs.</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-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">signo:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) signal identifier</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.DeviceClass.unregister_signal">
<tt class="descname">unregister_signal</tt><big>(</big><em>self</em>, <em>signo</em><big>)</big> → None<a class="headerlink" href="#PyTango.DeviceClass.unregister_signal" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div><blockquote>
<div>Unregister a signal.
Unregister this class as class to be informed when signal signo
is sent to 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"><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">signo:</th><td class="field-body">(<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) signal identifier</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>
</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="logging.html" title="Logging decorators"
>next</a> |</li>
<li class="right" >
<a href="device.html" title="Device"
>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>
|