poolmetacontroller

This module is part of the Python Pool libray. It defines the base classes for

Classes

DataInfo TypeData

ControllerLibrary

ControllerClass

DataInfo

class DataInfo(name, dtype, dformat=<_mock._Mock object>, access=<_mock._Mock object>, description='', default_value=None, memorized='true', fget=None, fset=None, maxdimsize=None)

Bases: object

copy()

classmethod toDataInfo(klass, name, info)

toDict()

serialize(*args, **kwargs)

TypeData

class TypeData(**kwargs)

Bases: object

Information for a specific Element type

ControllerLib

class ControllerLibrary(**kwargs)

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

serialize(*args, **kwargs)

controllers

ControllerClass

class ControllerClass(**kwargs)

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.

serialize(*args, **kwargs)

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 0x7f30b6dc2a10>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc2450>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc2210>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc22d0>: <class 'sardana.pool.poolcontroller.PoolPseudoCounterController'>, <_mock._Mock object at 0x7f30b6dc2fd0>: <class 'sardana.pool.poolcontroller.PoolPseudoMotorController'>, <_mock._Mock object at 0x7f30b6dc2190>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc23d0>: <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 0x7f30b7b814d0>: ('MeasurementGroup', 'MeasurementGroup', <class 'sardana.pool.poolmeasurementgroup.PoolMeasurementGroup'>, 'mntgrp/{pool_name}/{name}', None), <_mock._Mock object at 0x7f30b6dc2150>: ('TwoDExpChannel', 'ExpChannel', <class 'sardana.pool.pooltwodexpchannel.Pool2DExpChannel'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.TwoDController'>), <_mock._Mock object at 0x7f30b6dc2d90>: ('Instrument', 'Instrument', <class 'sardana.pool.poolinstrument.PoolInstrument'>, '{full_name}', None), <_mock._Mock object at 0x7f30b6dc2590>: ('PseudoMotor', 'Motor', <class 'sardana.pool.poolpseudomotor.PoolPseudoMotor'>, 'pm/{ctrl_name}/{axis}', <class 'sardana.pool.controller.PseudoMotorController'>), <_mock._Mock object at 0x7f30b6dc25d0>: ('ZeroDExpChannel', 'ExpChannel', <class 'sardana.pool.poolzerodexpchannel.Pool0DExpChannel'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.ZeroDController'>), <_mock._Mock object at 0x7f30b6dc2e10>: ('CTExpChannel', 'ExpChannel', <class 'sardana.pool.poolcountertimer.PoolCounterTimer'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.CounterTimerController'>), <_mock._Mock object at 0x7f30b6dc2a50>: ('Motor', 'Motor', <class 'sardana.pool.poolmotor.PoolMotor'>, 'motor/{ctrl_name}/{axis}', <class 'sardana.pool.controller.MotorController'>), <_mock._Mock object at 0x7f30b6dc2e90>: ('Controller', 'Controller', {<_mock._Mock object at 0x7f30b6dc2a10>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc2450>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc2210>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc22d0>: <class 'sardana.pool.poolcontroller.PoolPseudoCounterController'>, <_mock._Mock object at 0x7f30b6dc2fd0>: <class 'sardana.pool.poolcontroller.PoolPseudoMotorController'>, <_mock._Mock object at 0x7f30b6dc2190>: <class 'sardana.pool.poolcontroller.PoolController'>, <_mock._Mock object at 0x7f30b6dc23d0>: <class 'sardana.pool.poolcontroller.PoolController'>}, 'controller/{klass}/{name}', <class 'sardana.pool.controller.Controller'>), <_mock._Mock object at 0x7f30b7b81f10>: ('MotorGroup', 'MotorGroup', <class 'sardana.pool.poolmotorgroup.PoolMotorGroup'>, 'mg/{pool_name}/{name}', None), <_mock._Mock object at 0x7f30b6dc2290>: ('OneDExpChannel', 'ExpChannel', <class 'sardana.pool.poolonedexpchannel.Pool1DExpChannel'>, 'expchan/{ctrl_name}/{axis}', <class 'sardana.pool.controller.OneDController'>), <_mock._Mock object at 0x7f30b7b81390>: ('PseudoCounter', 'ExpChannel', <class 'sardana.pool.poolpseudocounter.PoolPseudoCounter'>, 'pc/{ctrl_name}/{axis}', <class 'sardana.pool.controller.PseudoCounterController'>), <_mock._Mock object at 0x7f30b70f1390>: ('IORegister', 'IORegister', <class 'sardana.pool.poolioregister.PoolIORegister'>, 'ioregister/{ctrl_name}/{axis}', <class 'sardana.pool.controller.IORegisterController'>)}

dictionary dict<ElementType, tuple> where tuple is a sequence:

1. type string representation
2. family
3. internal pool class
4. automatic full name
5. controller class

TYPE_MAP_OBJ = {<_mock._Mock object at 0x7f30b6dc2e10>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1110>, <_mock._Mock object at 0x7f30b6dc2a50>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1cd0>, <_mock._Mock object at 0x7f30b6dc2e90>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1d50>, <_mock._Mock object at 0x7f30b6dc2290>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1490>, <_mock._Mock object at 0x7f30b7b814d0>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f13d0>, <_mock._Mock object at 0x7f30b70f1390>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1b50>, <_mock._Mock object at 0x7f30b7b81f10>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1ad0>, <_mock._Mock object at 0x7f30b7b81390>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f19d0>, <_mock._Mock object at 0x7f30b6dc2150>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f10d0>, <_mock._Mock object at 0x7f30b6dc2590>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1990>, <_mock._Mock object at 0x7f30b6dc2d90>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f1810>, <_mock._Mock object at 0x7f30b6dc25d0>: <sardana.pool.poolmetacontroller.TypeData object at 0x7f30b70f18d0>}

dictionary dict<ElementType, TypeData>