ophyd.status.MoveStatus

class ophyd.status.MoveStatus(positioner, target, *, start_ts=None, **kwargs)

Track the state of a movement from some initial to final “position”.

The position could a physical position, a “position” in a pseudo-space, a temperature, etc. This constraint allows richer support for progress bars, including progress updates and an ETA.

Parameters

positionerPositioner

targetfloat or array-like

Target position

donebool, optional

Whether or not the motion has already completed

successbool, optional

If motion has already completed, the status of that motion

start_tsfloat, optional

The motion start timestamp

timeoutfloat, optional

The default timeout to use for a blocking wait, and the amount of time to wait to mark the motion as failed

settle_timefloat, optional

The amount of time to wait between motion completion and running callbacks

Attributes

posPositioner

targetfloat or array-like

Target position

donebool

Boolean indicating whether associated operation has completed.

start_tsfloat

The motion start timestamp

finish_tsfloat

The motion completd timestamp

finish_posfloat or ndarray

The final position

successbool

Boolean indicating whether associated operation has completed.

__init__(positioner, target, *, start_ts=None, **kwargs)

Methods

__init__(positioner, target, *[, start_ts])
add_callback(callback)	Register a callback to be called once when the Status finishes.
exception([timeout])	Return the exception raised by the action.
set_exception(exc)	Mark as finished but failed with the given Exception.
set_finished()	Mark as finished successfully.
wait([timeout])	Block until the action completes.
watch(func)	Subscribe to notifications about partial progress.

Attributes

callbacks	Callbacks to be run when the status is marked as finished
done	Boolean indicating whether associated operation has completed.
elapsed	Elapsed time
error	Error between target position and current* position
finished_cb
settle_time	A delay between when set_finished() is when the Status is done.
success	Boolean indicating whether associated operation has completed.
timeout	The timeout for this action.