#!/usr/bin/env python
#############################################################################
##
# This file is part of Sardana, a Tango User Interface Library
##
# http://www.sardana-controls.org/
##
# Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
# Sardana 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.
##
# Sardana 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 Sardana. If not, see <http://www.gnu.org/licenses/>.
##
#############################################################################
__all__ = ("SarDemoEnv", "getElements", "getControllers", "getMotors",
"getPseudoMotors", "getMoveables", "getCTs", "getZerods",
"getOneds", "getTwods", "getIORs")
from taurus import Device
from sardana.taurus.core.tango.sardana import registerExtensions
from taurus.core.util.singleton import Singleton
from sardana import sardanacustomsettings
from sardana.sardanautils import is_number
[docs]class SarDemoEnv(Singleton):
"""Class to get _SAR_DEMO environment variable with cross checking with
the MacroServer (given by :attr:`UNITTEST_DOOR_NAME`)
"""
ready = False
# when building docs, in RTD environment, init is never called - Singleton
# (comming from taurus) is a mock
[docs] def init(self, door_name=None):
if door_name is None:
door_name = getattr(sardanacustomsettings, 'UNITTEST_DOOR_NAME')
# TODO: As a workaround: check with PyTango that the door is running
# in case of exception raise a RuntimeError. Ideally it should be done
# just using taurus
try:
import PyTango
d = PyTango.DeviceProxy(door_name)
# when building docs, in RTD environment, PyTango is a mock
assert is_number(d.ping())
except:
raise RuntimeError("Door %s is not running" % door_name)
registerExtensions()
self.door = Device(door_name)
self.ms = self.door.macro_server
self.controllers = None
self.cts = None
self.motors = None
self.pseudos = None
self.zerods = None
self.oneds = None
self.twods = None
try:
self.env = self.ms.getEnvironment()['_SAR_DEMO']['elements'] + \
list(self.ms.getEnvironment()['_SAR_DEMO']['controllers'])
except KeyError:
err = 'sar_demo has not been executed (or door %s not ready)' % \
door_name
raise RuntimeError(err)
self.ready = True
[docs] def getElements(self, elem_type='all'):
"""Return the name of sardemo element(s) of given elem type
:param elem_type: (str) type of elemnts to return (all by default)
:return: (list<str>)
"""
if not self.ready:
raise RuntimeError(
'SarDemoEnv instantiation had previously failed')
if elem_type.lower() == 'all':
return self.env
if elem_type.lower() == 'moveable':
return self.getElements('motor') + self.getElements('pseudomotor')
ms_elems = self.ms.getElementNamesOfType(elem_type)
elems = [e for e in ms_elems if e is not None and e in self.env]
return elems
[docs] def getMoveables(self):
"""Return the name of moveable(s) defined by SarDemo
:return: (list<str>)
"""
return self.getMotors() + self.getPseudoMotors()
[docs] def getControllers(self):
"""Return the name of controllers(s) defined by SarDemo
:return: (list<str>)
"""
if not self.controllers:
self.controllers = self.getElements('controller')
return self.controllers
[docs] def getCTs(self):
"""Return the name of counter timer exp channel(s) defined by SarDemo
:return: (list<str>)
"""
if not self.cts:
self.cts = self.getElements('ctexpchannel')
return self.cts
[docs] def getMotors(self):
"""Return the name of motor(s) defined by SarDemo
:return: (list<str>)
"""
if not self.motors:
self.motors = self.getElements('motor')
return self.motors
[docs] def getPseudoMotors(self):
"""Return the name of pseudomotor(s) defined by SarDemo
:return: (list<str>)
"""
if not self.pseudos:
self.pseudos = self.getElements('pseudomotor')
return self.pseudos
[docs] def getZerods(self):
"""Return the name of zerod exp channel(s) defined by SarDemo
:return: (list<str>)
"""
if not self.zerods:
self.zerods = self.getElements('zerodexpchannel')
return self.zerods
[docs] def getOneds(self):
"""Return the name of one exp channel(s) defined by SarDemo
:return: (list<str>)
"""
if not self.oneds:
self.oneds = self.getElements('onedexpchannel')
return self.oneds
[docs] def getTwods(self):
"""Return the name of two exp channel(s) defined by SarDemo
:return: (list<str>)
"""
if not self.twods:
self.twods = self.getElements('twodexpchannel')
return self.twods
[docs] def changeDoor(self, door_name):
"""Change the door name and reset all lists
"""
self.__init__(door_name)
def getElements(elem_type="all", fallback_name="element_not_defined",
fallback_elements_len=5):
if fallback_name is None:
fallback_name = elem_type + "_not_defined"
try:
elements = SarDemoEnv().getElements(elem_type)
except RuntimeError:
import taurus
from sardana import sardanacustomsettings
door_name = getattr(sardanacustomsettings, 'UNITTEST_DOOR_NAME',
'UNDEFINED')
taurus.warning("The door %s is not running. " % (door_name) +
"Ignore this message if you are building the documentation.")
elements = [fallback_name] * fallback_elements_len
except Exception as e:
import taurus
taurus.debug(e)
taurus.warning("It was not possible to retrieve the element. " +
"Ignore this message if you are building the documentation.")
elements = [fallback_name] * fallback_elements_len
return elements
def getControllers():
return getElements(elem_type="controller")
def getCTs():
return getElements(elem_type="ctexpchannel")
def getMotors():
return getElements(elem_type="motor")
def getPseudoMotors():
return getElements(elem_type="pseudomotor")
def getMoveables():
return getElements(elem_type="moveable")
def getZerods():
return getElements(elem_type="zerodexpchannel")
def getOneds():
return getElements(elem_type="onedexpchannel")
def getTwods():
return getElements(elem_type="twodexpchannel")
def getIORs():
return getElements(elem_type="ioregister")
if __name__ == '__main__':
s = SarDemoEnv()
print(s.env)
print(s.getControllers())
print(s.getCTs())
print(s.getMotors())
print(s.getPseudoMotors())
print(s.getZerods())
print(s.getOneds())
print(s.getTwods())
print(s.getElements('Moveable'))
print(s.getMoveables())
print(s.getElements())