ophyd.areadetector.base.ADComponent#

class ophyd.areadetector.base.ADComponent(cls: Type[K], suffix: Optional[str] = None, *, lazy: Optional[bool] = None, trigger_value: Optional[Any] = None, add_prefix: Optional[Sequence[str]] = None, doc: Optional[str] = None, kind: Union[str, Kind] = Kind.normal, **kwargs)#
__init__(cls: Type[K], suffix: Optional[str] = None, *, lazy: Optional[bool] = None, trigger_value: Optional[Any] = None, add_prefix: Optional[Sequence[str]] = None, doc: Optional[str] = None, kind: Union[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_device

Does this Component contain a Device?

is_signal

Does this Component contain a Signal?

lazy_default

Default laziness for the component.

attr

The attribute name of the component.

cls

The class to instantiate when the device is created.

kwargs

Keyword arguments for the device creation.

lazy

Lazily create components on access.

suffix

PV or identifier suffix.

doc

Documentation string.

trigger_value

Value to send on trigger()

kind

The data acquisition kind.

add_prefix

Names of kwarg keys to prepend the device PV prefix to.