poolmetacontroller
¶
This module is part of the Python Pool libray. It defines the base classes for
Classes
DataInfo¶
ControllerLib¶
-
class
ControllerLibrary
(**kwargs)[source]¶ Bases:
sardana.sardanameta.SardanaLibrary
Object representing a python module containning controller classes. Public members:
module - reference to python module
f_path - complete (absolute) path and filename
f_name - filename (including file extension)
path - complete (absolute) path
name - module name (without file extension)
controller_list - list<ControllerClass>
- exc_info - exception information if an error occured when loading
the module
-
add_controller
(meta_class)¶ Adds a new :class:~`sardana.sardanameta.SardanaClass` to this library.
Parameters: meta_class (:class:~`sardana.sardanameta.SardanaClass`) – the meta class to be added to this library
-
get_controller
(meta_class_name)¶ Returns a :class:~`sardana.sardanameta.SardanaClass` for the given meta class name or None if the meta class does not exist in this library.
Parameters: meta_class_name (str) – the meta class name Returns: a meta class or None Return type: :class:~`sardana.sardanameta.SardanaClass`
-
get_controllers
()¶ Returns a sequence of the meta classes that belong to this library.
Returns: a sequence of meta classes that belong to this library Return type: seq<:class:~`sardana.sardanameta.SardanaClass`>
-
has_controller
(meta_class_name)¶ Returns True if the given meta class name belongs to this library or False otherwise.
Parameters: meta_class_name (str) – the meta class name Returns: True if the given meta class name belongs to this library or False otherwise Return type: bool
-
controllers
¶
ControllerClass¶
-
class
ControllerClass
(**kwargs)[source]¶ Bases:
sardana.sardanameta.SardanaClass
Object representing a python controller class. Public members:
- name - class name
- klass - python class object
- lib - ControllerLibrary object representing the module where the controller is.
-
controller_class
¶
-
gender
¶
-
model
¶
-
organization
¶
Constants
-
CONTROLLER_TEMPLATE
= 'class @controller_name@(@controller_type@):\n """@controller_name@ description."""\n\n'¶ String containing template code for a controller class
-
CTRL_TYPE_MAP
= {<_mock._Mock object at 0x7f10b7f4b650>: <class 'sardana.pool.poolcontroller.PoolPseudoMotorController'>, <_mock._Mock object at 0x7f10b7ed7890>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7ed78d0>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7ed7110>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7f4ba90>: <class 'sardana.pool.poolcontroller.PoolPseudoCounterController'>, <_mock._Mock object at 0x7f10b7ed7f90>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7f4b5d0>: <class 'sardana.pool.poolcontroller.PoolController'>}¶ a dictionary dict<
ElementType
, class> mapping element type enumeration with the corresponding controller pool class (PoolController
or sub-class of it).
-
TYPE_MAP
= {<_mock._Mock object at 0x7f10b7f4b410>: ('Controller', 'Controller', {<_mock._Mock object at 0x7f10b7f4b650>: <class 'sardana.pool.poolcontroller.PoolPseudoMotorController'>, <_mock._Mock object at 0x7f10b7ed7890>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7ed78d0>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7ed7110>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7f4ba90>: <class 'sardana.pool.poolcontroller.PoolPseudoCounterController'>, <_mock._Mock object at 0x7f10b7ed7f90>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f10b7f4b5d0>: <class 'sardana.pool.poolcontroller.PoolController'>}, 'controller/{klass}/{name}', <class 'sardana.pool.controller.Controller'>), <_mock._Mock object at 0x7f10b7f4b050>: ('MotorGroup', 'MotorGroup', <class 'sardana.pool.poolmotorgroup.PoolMotorGroup'>, 'mg/{pool_name}/{name}', None), <_mock._Mock object at 0x7f10b7f4b4d0>: ('MeasurementGroup', 'MeasurementGroup', <class 'sardana.pool.poolmeasurementgroup.PoolMeasurementGroup'>, 'mntgrp/{pool_name}/{name}', None), <_mock._Mock object at 0x7f10b7f4b0d0>: ('Instrument', 'Instrument', <class 'sardana.pool.poolinstrument.PoolInstrument'>, '{full_name}', None), <_mock._Mock object at 0x7f10b7f4b910>: ('ZeroDExpChannel', 'ExpChannel', <class 'sardana.pool.poolzerodexpchannel.Pool0DExpChannel'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.ZeroDController'>), <_mock._Mock object at 0x7f10b7f4b150>: ('IORegister', 'IORegister', <class 'sardana.pool.poolioregister.PoolIORegister'>, 'ioregister/{ctrl_name}/{axis}', <class 'sardana.pool.controller.IORegisterController'>), <_mock._Mock object at 0x7f10b7f4bc50>: ('Motor', 'Motor', <class 'sardana.pool.poolmotor.PoolMotor'>, 'motor/{ctrl_name}/{axis}', <class 'sardana.pool.controller.MotorController'>), <_mock._Mock object at 0x7f10b7f4ba50>: ('PseudoCounter', 'ExpChannel', <class 'sardana.pool.poolpseudocounter.PoolPseudoCounter'>, 'pc/{ctrl_name}/{axis}', <class 'sardana.pool.controller.PseudoCounterController'>), <_mock._Mock object at 0x7f10b7f4bd10>: ('CTExpChannel', 'ExpChannel', <class 'sardana.pool.poolcountertimer.PoolCounterTimer'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.CounterTimerController'>), <_mock._Mock object at 0x7f10b7f4bb10>: ('TwoDExpChannel', 'ExpChannel', <class 'sardana.pool.pooltwodexpchannel.Pool2DExpChannel'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.TwoDController'>), <_mock._Mock object at 0x7f10b7f4be50>: ('PseudoMotor', 'Motor', <class 'sardana.pool.poolpseudomotor.PoolPseudoMotor'>, 'pm/{ctrl_name}/{axis}', <class 'sardana.pool.controller.PseudoMotorController'>), <_mock._Mock object at 0x7f10b7f4bbd0>: ('OneDExpChannel', 'ExpChannel', <class 'sardana.pool.poolonedexpchannel.Pool1DExpChannel'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.OneDController'>)}¶ dictionary dict<
ElementType
,tuple
> where tuple is a sequence:- type string representation
- family
- internal pool class
- automatic full name
- controller class
-
TYPE_MAP_OBJ
= {<_mock._Mock object at 0x7f10b7f4b410>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b990>, <_mock._Mock object at 0x7f10b7f4b050>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b310>, <_mock._Mock object at 0x7f10b7f4bd10>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b490>, <_mock._Mock object at 0x7f10b7f4b0d0>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b390>, <_mock._Mock object at 0x7f10b7f4b4d0>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b190>, <_mock._Mock object at 0x7f10b7f4b910>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b8d0>, <_mock._Mock object at 0x7f10b7f4b150>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b590>, <_mock._Mock object at 0x7f10b7f4bb10>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b3d0>, <_mock._Mock object at 0x7f10b7f4ba50>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b550>, <_mock._Mock object at 0x7f10b7f4be50>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b6d0>, <_mock._Mock object at 0x7f10b7f4bbd0>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b610>, <_mock._Mock object at 0x7f10b7f4bc50>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f10b7f4b090>}¶ dictionary dict<
ElementType
,TypeData
>