"""
Mixin to add EPICS .DESC field
+++++++++++++++++++++++++++++++++++++++
.. autosummary::
~EpicsDescriptionMixin
"""
from ophyd import Component
from ophyd import EpicsSignal
from .mixin_base import DeviceMixinBase
[docs]class EpicsDescriptionMixin(DeviceMixinBase):
"""
add a record's description field to a Device, such as EpicsMotor
.. index:: Ophyd Device Mixin; EpicsDescriptionMixin
EXAMPLE::
from ophyd import EpicsMotor
from apstools.devices import EpicsDescriptionMixin
class MyEpicsMotor(EpicsDescriptionMixin, EpicsMotor): pass
m1 = MyEpicsMotor('xxx:m1', name='m1')
print(m1.desc.get())
more ideas::
class TunableSynAxis(AxisTunerMixin, SynAxis):
'''synthetic axis that can be tuned'''
class TunableEpicsMotor(AxisTunerMixin, EpicsMotor):
'''EpicsMotor that can be tuned'''
class EpicsMotorWithDescription(EpicsDescriptionMixin, EpicsMotor):
'''EpicsMotor with description field'''
class EpicsMotorWithMore(
EpicsDescriptionMixin,
EpicsMotorLimitsMixin,
EpicsMotorDialMixin,
EpicsMotorRawMixin,
EpicsMotor):
'''
EpicsMotor with more fields
* description (``desc``)
* soft motor limits (``soft_limit_hi``, ``soft_limit_lo``)
* dial coordinates (``dial``)
* raw coordinates (``raw``)
'''
"""
desc = Component(EpicsSignal, ".DESC")
# -----------------------------------------------------------------------------
# :author: Pete R. Jemian
# :email: jemian@anl.gov
# :copyright: (c) 2017-2022, UChicago Argonne, LLC
#
# Distributed under the terms of the Creative Commons Attribution 4.0 International Public License.
#
# The full license is in the file LICENSE.txt, distributed with this software.
# -----------------------------------------------------------------------------