Note

Ophyd async is included on a provisional basis until the v1.0 release and may change API on minor release numbers before then

ophyd_async.core.DeviceVector#

class ophyd_async.core.DeviceVector[source]#

Bases: Dict[int, VT], Device

Defines device components with indices.

In the below example, foos becomes a dictionary on the parent device at runtime, so parent.foos[2] returns a FooDevice. For example usage see DynamicSensorGroup

Methods

`children`
`clear`
`connect`	Connect self and all child Devices.
`copy`
`fromkeys`	Create a new dictionary with keys from iterable and values set to value.
`get`	Return the value for key if key is in the dictionary, else default.
`items`
`keys`
`pop`	If the key is not found, return the default if given; otherwise, raise a KeyError.
`popitem`	Remove and return a (key, value) pair as a 2-tuple.
`set_name`	Set `self.name=name` and each `self.child.name=name+"-child"`.
`setdefault`	Insert key with a value of default if key is not in the dictionary.
`update`	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
`values`

Attributes

`name`	Return the name of the Device
`parent`	The parent Device if it exists

clear() → None. Remove all items from D.#

async connect(sim: bool = False, timeout: float = 10.0)#

Connect self and all child Devices.

Contains a timeout that gets propagated to child.connect methods.

Parameters:

sim – If True then connect in simulation mode.
timeout – Time to wait before failing with a TimeoutError.

copy() → a shallow copy of D#

fromkeys(iterable, value=None, /)#: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)#: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items#

keys() → a set-like object providing a view on D's keys#

property name: str#: Return the name of the Device

pop(key, default=<unrepresentable>, /)#: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(/)#

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

set_name(name: str)#

Set self.name=name and each self.child.name=name+"-child".

Parameters:: name – New name to set

setdefault(key, default=None, /)#

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.#: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values#