franky.BoolFuture

class franky.BoolFuture

Bases: pybind11_object

A future that will eventually contain a boolean result, e.g. of an asynchronous gripper command.

__init__(*args, **kwargs)

get(self: franky._franky.BoolFuture) → bool

Wait for the result and return it. Blocks until the result is available.

wait(self: franky._franky.BoolFuture, timeout: SupportsFloat | SupportsIndex | None = None) → bool

Wait for the result to become available.

Parameters:

timeout – Maximum time to wait [s]. If None, waits indefinitely.

Returns:

True if the result became available before the timeout expired, False otherwise.