ophyd.positioner.PositionerBase.set

PositionerBase.set(new_position: typing.Any, *, timeout: float = None, moved_cb: typing.Callable = None, wait: bool = False) → ophyd.status.StatusBase

Set a value and return a Status object

Parameters:

new_position : object

The input here is whatever the device requires (this should be over-ridden by the implementation. For example a motor would take a float, a shutter the strings {‘Open’, ‘Close’}, and a goineometer (h, k, l) tuples

timeout : float, optional

Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

moved_cb : callable, optional

Deprecated

Call this callback when movement has finished. This callback must accept one keyword argument: ‘obj’ which will be set to this positioner instance.

wait : bool, optional

Deprecated

If the method should block until the Status object reports it is done.

Defaults to False

Returns:

status : StatusBase

Status object to indicate when the motion / set is done.