ophyd.positioner.PositionerBase.set

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

Set a value and return a Status object

Parameters

new_positionobject

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

timeoutfloat, optional

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

moved_cbcallable, 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.

waitbool, optional

Deprecated

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

Defaults to False

Returns

statusStatusBase

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