ophyd.areadetector.base.ADComponent#
- class ophyd.areadetector.base.ADComponent(cls: Type[K], suffix: str | None = None, *, lazy: bool | None = None, trigger_value: Any | None = None, add_prefix: Sequence[str] | None = None, doc: str | None = None, kind: str | Kind = Kind.normal, **kwargs)#
- __init__(cls: Type[K], suffix: str | None = None, *, lazy: bool | None = None, trigger_value: Any | None = None, add_prefix: Sequence[str] | None = None, doc: str | None = None, kind: str | Kind = Kind.normal, **kwargs)#
Methods
__init__(cls[, suffix, lazy, trigger_value, ...])create_component(instance)Instantiate the object described by this Component for a Device
find_docs(parent_class)Find all the documentation related to this class, all the way up the MRO
make_docstring(parent_class)Create a docstring for the component, given the parent class
maybe_add_prefix(instance, kw, suffix)Add prefix to a suffix if kw is in self.add_prefix
sub_default(func)Default subscription decorator
sub_meta(func)Metadata subscription decorator
sub_value(func)Value subscription decorator
subscriptions(event_type)(Decorator) Specify subscriptions callbacks in the Device definition
Attributes
is_deviceDoes this Component contain a Device?
is_signalDoes this Component contain a Signal?
lazy_defaultDefault laziness for the component.
attrThe attribute name of the component.
clsThe class to instantiate when the device is created.
kwargsKeyword arguments for the device creation.
lazyLazily create components on access.
suffixPV or identifier suffix.
docDocumentation string.
trigger_valueValue to send on
trigger()kindThe data acquisition kind.
add_prefixNames of kwarg keys to prepend the device PV prefix to.