/usr/share/pyshared/PyTango/device_class.py is in python-pytango 7.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 | ################################################################################
##
## This file is part of PyTango, a python binding for Tango
##
## http://www.tango-controls.org/static/PyTango/latest/doc/html/index.html
##
## Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
## PyTango is free software: you can redistribute it and/or modify
## it under the terms of the GNU Lesser General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## PyTango is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU Lesser General Public License for more details.
##
## You should have received a copy of the GNU Lesser General Public License
## along with PyTango. If not, see <http://www.gnu.org/licenses/>.
##
################################################################################
"""
This is an internal PyTango module.
"""
__all__ = [ "DeviceClass" ]
__docformat__ = "restructuredtext"
import types
import operator
from _PyTango import Except, DevFailed
from _PyTango import _DeviceClass, Database
from _PyTango import CmdArgType, DispLevel
from _PyTango import UserDefaultAttrProp
from pyutil import Util
from utils import seqStr_2_obj, obj_2_str, is_array
from utils import document_method as __document_method
from globals import get_class, get_class_by_class
from globals import get_constructed_class_by_class
from attr_data import AttrData
class PropUtil:
"""An internal Property util class"""
scalar_int_types = (CmdArgType.DevShort, CmdArgType.DevUShort,
CmdArgType.DevInt, CmdArgType.DevLong, CmdArgType.DevULong,)
scalar_long_types = (CmdArgType.DevLong64, CmdArgType.DevULong64)
scalar_float_types = (CmdArgType.DevFloat, CmdArgType.DevDouble,)
scalar_numerical_types = scalar_int_types + scalar_long_types + scalar_float_types
scalar_str_types = (CmdArgType.DevString, CmdArgType.ConstDevString,)
scalar_types = scalar_numerical_types + scalar_str_types + \
(CmdArgType.DevBoolean, CmdArgType.DevEncoded,
CmdArgType.DevUChar, CmdArgType.DevVoid)
def __init__(self):
self.db = None
if Util._UseDb:
self.db = Database()
def set_default_property_values(self, dev_class, class_prop, dev_prop):
"""
set_default_property_values(self, dev_class, class_prop, dev_prop) -> None
Sets the default property values
Parameters :
- dev_class : (DeviceClass) device class object
- class_prop : (dict<str,>) class properties
- dev_prop : (dict<str,>) device properties
Return : None
"""
for name in class_prop.keys():
type = self.get_property_type(name, class_prop)
val = self.get_property_values(name, class_prop)
val = self.values2string(val, type)
desc = self.get_property_description(name, class_prop)
dev_class.add_wiz_class_prop(name, desc, val)
for name in dev_prop.keys():
type = self.get_property_type(name, dev_prop)
val = self.get_property_values(name, dev_prop)
val = self.values2string(val, type)
desc = self.get_property_description(name, dev_prop)
dev_class.add_wiz_dev_prop(name, desc, val)
def get_class_properties(self, dev_class, class_prop):
"""
get_class_properties(self, dev_class, class_prop) -> None
Returns the class properties
Parameters :
- dev_class : (DeviceClass) the DeviceClass object
- class_prop : [in, out] (dict<str, None>) the property names. Will be filled
with property values
Return : None"""
# initialize default values
if class_prop == {} or Util._UseDb == False:
return
# call database to get properties
props = self.db.get_class_property(dev_class.get_name(), class_prop.keys())
# if value defined in database, store it
for name in class_prop.keys():
if props[name]:
type = self.get_property_type(name, class_prop)
values = self.stringArray2values(props[name], type)
self.set_property_values(name, class_prop, values)
else:
print name, " property NOT found in database"
def get_device_properties(self, dev, class_prop, dev_prop):
"""
get_device_properties(self, dev, class_prop, dev_prop) -> None
Returns the device properties
Parameters :
- dev : (DeviceImpl) the device object
- class_prop : (dict<str, obj>) the class properties
- dev_prop : [in,out] (dict<str, None>) the device property names
Return : None"""
# initialize default properties
if dev_prop == {} or Util._UseDb == False:
return
# Call database to get properties
props = self.db.get_device_property(dev.get_name(),dev_prop.keys())
# if value defined in database, store it
for name in dev_prop.keys():
prop_value = props[name]
if len(prop_value):
data_type = self.get_property_type(name, dev_prop)
values = self.stringArray2values(prop_value, data_type)
if not self.is_empty_seq(values):
self.set_property_values(name, dev_prop, values)
else:
# Try to get it from class property
values = self.get_property_values(name, class_prop)
if not self.is_empty_seq(values):
if not self.is_seq(values):
values = [values]
data_type = self.get_property_type(name, class_prop)
values = self.stringArray2values(values, data_type)
if not self.is_empty_seq(values):
self.set_property_values(name, dev_prop, values)
else:
# Try to get it from class property
values = self.get_property_values(name, class_prop)
if not self.is_empty_seq(values):
if not self.is_seq(values):
values = [values]
data_type = self.get_property_type(name, class_prop)
values = self.stringArray2values(values, data_type)
if not self.is_empty_seq(values):
self.set_property_values(name, dev_prop, values)
def is_seq(self, v):
"""
is_seq(self, v) -> bool
Helper method. Determines if the object is a sequence
Parameters :
- v : (object) the object to be analysed
Return : (bool) True if the object is a sequence or False otherwise"""
return operator.isSequenceType(v)
def is_empty_seq(self, v):
"""
is_empty_seq(self, v) -> bool
Helper method. Determines if the object is an empty sequence
Parameters :
- v : (object) the object to be analysed
Return : (bool) True if the object is a sequence which is empty or False otherwise"""
return self.is_seq(v) and not len(v)
def get_property_type(self, prop_name, properties):
"""
get_property_type(self, prop_name, properties) -> CmdArgType
Gets the property type for the given property name using the
information given in properties
Parameters :
- prop_name : (str) property name
- properties : (dict<str,data>) property data
Return : (CmdArgType) the tango type for the given property"""
try:
tg_type = properties[prop_name][0]
except:
tg_type = CmdArgType.DevVoid
return tg_type
def set_property_values(self, prop_name, properties, values):
"""
set_property_values(self, prop_name, properties, values) -> None
Sets the property value in the properties
Parameters :
- prop_name : (str) property name
- properties : (dict<str,obj>) [in,out] dict which will contain the value
- values : (seq) the new property value
Return : None"""
properties[prop_name][2] = values
def get_property_values(self, prop_name, properties):
"""
get_property_values(self, prop_name, properties) -> obj
Gets the property value
Parameters :
- prop_name : (str) property name
- properties : (dict<str,obj>) properties
Return : (obj) the value for the given property name"""
try:
tg_type = self.get_property_type(prop_name, properties)
val = properties[prop_name][2]
except:
val = []
if is_array(tg_type) or (operator.isSequenceType(val) and not len(val)):
return val
else:
if operator.isSequenceType(val) and not type(val) in types.StringTypes:
return val[0]
else:
return val
def get_property_description(self, prop_name, properties):
"""
get_property_description(self, prop_name, properties) -> obj
Gets the property description
Parameters :
- prop_name : (str) property name
- properties : (dict<str,obj>) properties
Return : (str) the description for the given property name"""
return properties[prop_name][1]
def stringArray2values(self, argin, argout_type):
"""internal helper method"""
return seqStr_2_obj(argin, argout_type)
def values2string(self, argin, argout_type):
"""internal helper method"""
return obj_2_str(argin, argout_type)
class DeviceClass(_DeviceClass):
"""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"""
class_property_list = {}
device_property_list = {}
cmd_list = {}
attr_list = {}
def __init__(self, name):
_DeviceClass.__init__(self,name)
self.dyn_att_added_methods = []
try:
pu = self.prop_util = PropUtil()
self.py_dev_list = []
pu.set_default_property_values(self, self.class_property_list,
self.device_property_list)
pu.get_class_properties(self, self.class_property_list)
for prop_name in self.class_property_list.keys():
setattr(self, prop_name, pu.get_property_values(prop_name, self.class_property_list))
except DevFailed, df:
print("PyDS: %s: A Tango error occured in the constructor:" % name)
Except.print_exception(df)
except Exception, e:
print("PyDS: %s: An error occured in the constructor:" % name)
print(str(e))
def __str__(self):
return '%s(%s)' % (self.__class__.__name__, self.get_name())
def __repr__(self):
return '%s(%s)' % (self.__class__.__name__, self.get_name())
def __throw_create_attribute_exception(self, msg):
"""Helper method to throw DevFailed exception when inside create_attribute"""
Except.throw_exception("PyDs_WrongAttributeDefinition", msg, "create_attribute()")
def __throw_create_command_exception(self, msg):
"""Helper method to throw DevFailed exception when inside create_command"""
Except.throw_exception("PyDs_WrongCommandDefinition", msg, "create_command()")
def __attribute_factory(self, attr_list):
"""for internal usage only"""
for attr_name, attr_info in self.attr_list.iteritems():
attr_data = AttrData(attr_name, self.get_name(), attr_info)
self.__create_attribute(attr_list, attr_data)
def __create_attribute(self, attr_list, attr_data):
"""for internal usage only"""
self._create_attribute(attr_list, attr_data.attr_name,
attr_data.attr_type, attr_data.attr_format,
attr_data.attr_write, attr_data.dim_x,
attr_data.dim_y, attr_data.display_level,
attr_data.polling_period, attr_data.memorized,
attr_data.hw_memorized,
attr_data.read_method_name,
attr_data.write_method_name,
attr_data.is_allowed_name, attr_data.att_prop)
def __create_user_default_attr_prop(self, attr_name, extra_info):
"""for internal usage only"""
p = UserDefaultAttrProp()
for k, v in extra_info.iteritems():
k_lower = k.lower()
method_name = "set_%s" % k_lower.replace(' ','_')
if hasattr(p, method_name):
method = getattr(p, method_name)
method(str(v))
elif k == 'delta_time':
p.set_delta_t(str(v))
elif not k_lower in ('display level', 'polling period', 'memorized'):
name = self.get_name()
msg = "Wrong definition of attribute %s in " \
"class %s\nThe object extra information '%s' " \
"is not recognized!" % (attr_name, name, k)
self.__throw_create_attribute_exception(msg)
return p
def __command_factory(self):
"""for internal usage only"""
name = self.get_name()
class_info = get_class(name)
deviceimpl_class = class_info[1]
if not hasattr(deviceimpl_class, "init_device"):
msg = "Wrong definition of class %s\n" \
"The init_device() method does not exist!" % name
Except.throw_exception("PyDs_WrongCommandDefinition", msg, "command_factory()")
for cmd_name, cmd_info in self.cmd_list.iteritems():
self.__create_command(deviceimpl_class, cmd_name, cmd_info)
def __create_command(self, deviceimpl_class, cmd_name, cmd_info):
"""for internal usage only"""
name = self.get_name()
# check for well defined command info
# check parameter
if not operator.isSequenceType(cmd_info):
msg = "Wrong data type for value for describing command %s in " \
"class %s\nMust be a sequence with 2 or 3 elements" % (cmd_name, name)
self.__throw_create_command_exception(msg)
if len(cmd_info) < 2 or len(cmd_info) > 3:
msg = "Wrong number of argument for describing command %s in " \
"class %s\nMust be a sequence with 2 or 3 elements" % (cmd_name, name)
self.__throw_create_command_exception(msg)
param_info, result_info = cmd_info[0], cmd_info[1]
if not operator.isSequenceType(param_info):
msg = "Wrong data type in command argument for command %s in " \
"class %s\nCommand parameter (first element) must be a sequence" % (cmd_name, name)
self.__throw_create_command_exception(msg)
if len(param_info) < 1 or len(param_info) > 2:
msg = "Wrong data type in command argument for command %s in " \
"class %s\nSequence describing command parameters must contain " \
"1 or 2 elements"
self.__throw_create_command_exception(msg)
param_type = CmdArgType.DevVoid
try:
param_type = CmdArgType(param_info[0])
except:
msg = "Wrong data type in command argument for command %s in " \
"class %s\nCommand parameter type (first element in first " \
"sequence) must be a PyTango.CmdArgType"
self.__throw_create_command_exception(msg)
param_desc = ""
if len(param_info) > 1:
param_desc = param_info[1]
if not type(param_desc) in types.StringTypes:
msg = "Wrong data type in command parameter for command %s in " \
"class %s\nCommand parameter description (second element " \
"in first sequence), when given, must be a string"
self.__throw_create_command_exception(msg)
# Check result
if not operator.isSequenceType(result_info):
msg = "Wrong data type in command result for command %s in " \
"class %s\nCommand result (second element) must be a sequence" % (cmd_name, name)
self.__throw_create_command_exception(msg)
if len(result_info) < 1 or len(result_info) > 2:
msg = "Wrong data type in command result for command %s in " \
"class %s\nSequence describing command result must contain " \
"1 or 2 elements" % (cmd_name, name)
self.__throw_create_command_exception(msg)
result_type = CmdArgType.DevVoid
try:
result_type = CmdArgType(result_info[0])
except:
msg = "Wrong data type in command result for command %s in " \
"class %s\nCommand result type (first element in second " \
"sequence) must be a PyTango.CmdArgType" % (cmd_name, name)
self.__throw_create_command_exception(msg)
result_desc = ""
if len(result_info) > 1:
result_desc = result_info[1]
if not type(result_desc) in types.StringTypes:
msg = "Wrong data type in command result for command %s in " \
"class %s\nCommand parameter description (second element " \
"in second sequence), when given, must be a string" % (cmd_name, name)
self.__throw_create_command_exception(msg)
# If it is defined, get addictional dictionnary used for optional parameters
display_level, default_command, polling_period = DispLevel.OPERATOR, False, -1
if len(cmd_info) == 3:
extra_info = cmd_info[2]
if not operator.isMappingType(extra_info):
msg = "Wrong data type in command information for command %s in " \
"class %s\nCommand information (third element in sequence), " \
"when given, must be a dictionary" % (cmd_name, name)
self.__throw_create_command_exception(msg)
if len(extra_info) > 3:
msg = "Wrong data type in command information for command %s in " \
"class %s\nThe optional dictionary can not have more than " \
"three elements" % (cmd_name, name)
self.__throw_create_command_exception(msg)
for info_name, info_value in extra_info.iteritems():
info_name_lower = info_name.lower()
if info_name_lower == "display level":
try:
display_level = DispLevel(info_value)
except:
msg = "Wrong data type in command information for command %s in " \
"class %s\nCommand information for display level is not a " \
"PyTango.DispLevel" % (cmd_name, name)
self.__throw_create_command_exception(msg)
elif info_name_lower == "default command":
if not type(info_value) in types.StringTypes:
msg = "Wrong data type in command information for command %s in " \
"class %s\nCommand information for default command is not a " \
"string" % (cmd_name, name)
self.__throw_create_command_exception(msg)
v = info_value.lower()
default_command = v == 'true'
elif info_name_lower == "polling period":
try:
polling_period = int(info_value)
except:
msg = "Wrong data type in command information for command %s in " \
"class %s\nCommand information for polling period is not an " \
"integer" % (cmd_name, name)
self.__throw_create_command_exception(msg)
else:
msg = "Wrong data type in command information for command %s in " \
"class %s\nCommand information has unknown key " \
"%s" % (cmd_name, name, info_name)
self.__throw_create_command_exception(msg)
# check that the method to be executed exists
try:
cmd = getattr(deviceimpl_class, cmd_name)
if not callable(cmd):
msg = "Wrong definition of command %s in " \
"class %s\nThe object exists in class but is not " \
"a method!" % (cmd_name, name)
self.__throw_create_command_exception(msg)
except AttributeError:
msg = "Wrong definition of command %s in " \
"class %s\nThe command method does not exist!" % (cmd_name, name)
self.__throw_create_command_exception(msg)
is_allowed_name = "is_%s_allowed" % cmd_name
try:
is_allowed = getattr(deviceimpl_class, is_allowed_name)
if not callable(is_allowed):
msg = "Wrong definition of command %s in " \
"class %s\nThe object '%s' exists in class but is " \
"not a method!" % (cmd_name, name, is_allowed_name)
self.__throw_create_command_exception(msg)
except:
is_allowed_name = ""
self._create_command(cmd_name, param_type, result_type,
param_desc, result_desc,
display_level, default_command,
polling_period, is_allowed_name)
def device_factory(self, device_list):
"""for internal usage only"""
klass = self.__class__
klass_name = klass.__name__
info, klass = get_class_by_class(klass), get_constructed_class_by_class(klass)
if info is None:
raise RuntimeError("Device class '%s' is not registered" % klass_name)
if klass is None:
raise RuntimeError("Device class '%s' as not been constructed" % klass_name)
deviceClassClass, deviceImplClass, deviceImplName = info
deviceImplClass._device_class_instance = klass
tmp_dev_list = []
for dev_name in device_list:
device = deviceImplClass(klass, dev_name)
self._add_device(device)
tmp_dev_list.append(device)
self.dyn_attr(tmp_dev_list)
for dev in tmp_dev_list:
if Util._UseDb and not Util._FileDb:
self.export_device(dev)
else:
self.export_device(dev, dev.get_name())
self.py_dev_list += tmp_dev_list
def create_device(self, device_name, alias=None, cb=None):
"""
create_device(self, device_name, alias=None, cb=None) -> None
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)
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
Throws PyTango.DevFailed:
- the device name exists already or
- the given class is not registered for this DS.
- the cb is not a callable
New in PyTango 7.1.2
Parameters :
- device_name : (str) the device name
- alias : (str) optional alias. Default value is None meaning do not create device alias
- cb : (callable) 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
Return : None"""
util = Util.instance()
util.create_device(self.get_name(), device_name, alias=alias, cb=cb)
def delete_device(self, device_name):
"""
delete_device(self, klass_name, device_name) -> None
Deletes an existing device from the database and from this running
server
Throws PyTango.DevFailed:
- the device name doesn't exist in the database
- the device name doesn't exist in this DS.
New in PyTango 7.1.2
Parameters :
- klass_name : (str) the device class name
- device_name : (str) the device name
Return : None"""
util = Util.instance()
util.delete_device(self.get_name(), device_name)
def dyn_attr(self,device_list):
"""
dyn_attr(self,device_list) -> None
Default implementation does not do anything
Overwrite in order to provide dynamic attributes
Parameters :
- device_list : (seq<DeviceImpl>) sequence of devices of this class
Return : None"""
pass
def device_destroyer(self,name):
"""for internal usage only"""
name = name.lower()
for d in self.py_dev_list:
dname = d.get_name().lower()
if dname == name:
dev_cl = d.get_device_class()
# the internal C++ device_destroyer isn't case sensitive so we
# use the internal DeviceImpl name to make sure the DeviceClass
# finds it
dev_cl._device_destroyer(d.get_name())
self.py_dev_list.remove(d)
return
err_mess = "Device " + name + " not in Tango class device list!"
Except.throw_exception("PyAPI_CantDestroyDevice",err_mess,"DeviceClass.device_destroyer")
def __init_DeviceClass():
pass
def __doc_DeviceClass():
def document_method(method_name, desc, append=True):
return __document_method(DeviceClass, method_name, desc, append)
document_method("export_device", """
export_device(self, dev, corba_dev_name = 'Unused') -> None
For internal usage only
Parameters :
- dev : (DeviceImpl) device object
- corba_dev_name : (str) CORBA device name. Default value is 'Unused'
Return : None
""" )
document_method("register_signal", """
register_signal(self, signo) -> None
register_signal(self, signo, own_handler=false) -> None
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.
Parameters :
- signo : (int) signal identifier
- own_handler : (bool) 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
Throws PyTango.DevFailed:
- if the signal number is out of range
- if the operating system failed to register a signal for the process.
Return : None
""" )
document_method("unregister_signal", """
unregister_signal(self, signo) -> None
Unregister a signal.
Unregister this class as class to be informed when signal signo
is sent to to the device server process
Parameters :
- signo : (int) signal identifier
Return : None
""" )
document_method("signal_handler", """
signal_handler(self, signo) -> None
Signal handler.
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.
Parameters :
- signo : (int) signal identifier
Return : None
""" )
document_method("get_name", """
get_name(self) -> str
Get the TANGO device class name.
Parameters : None
Return : (str) the TANGO device class name.
""" )
document_method("get_type", """
get_type(self) -> str
Gets the TANGO device type name.
Parameters : None
Return : (str) the TANGO device type name
""" )
document_method("get_doc_url", """
get_doc_url(self) -> str
Get the TANGO device class documentation URL.
Parameters : None
Return : (str) the TANGO device type name
""" )
document_method("set_type", """
set_type(self, dev_type) -> None
Set the TANGO device type name.
Parameters :
- dev_type : (str) the new TANGO device type name
Return : None
""" )
document_method("get_cvs_tag", """
get_cvs_tag(self) -> str
Gets the cvs tag
Parameters : None
Return : (str) cvs tag
""" )
document_method("get_cvs_location", """
get_cvs_location(self) -> None
Gets the cvs localtion
Parameters : None
Return : (str) cvs location
""" )
document_method("get_device_list", """
get_device_list(self) -> sequence<PyTango.DeviceImpl>
Gets the list of PyTango.DeviceImpl objects for this class
Parameters : None
Return : (sequence<PyTango.DeviceImpl>) list of PyTango.DeviceImpl objects for this class
""" )
document_method("add_wiz_dev_prop", """
add_wiz_dev_prop(self, str, str) -> None
add_wiz_dev_prop(self, str, str, str) -> None
For internal usage only
Parameters : None
Return : None
""" )
document_method("add_wiz_class_prop", """
add_wiz_class_prop(self, str, str) -> None
add_wiz_class_prop(self, str, str, str) -> None
For internal usage only
Parameters : None
Return : None
""" )
def init(doc=True):
__init_DeviceClass()
if doc:
__doc_DeviceClass()
|