alias_api.AlPickable

class alias_api.AlPickable

Bases: pybind11_object

Basic Interface to Alias objects which can be picked.

This class encapsulates the functionality of Alias objects which have the capacity to be picked. As expected, pickable objects can either be picked or unpicked.

is_picked(self: alias_api.AlPickable) → int

Return True if the object is picked.

pick(self: alias_api.AlPickable) → int

Pick the object

unpick(self: alias_api.AlPickable) → int

Unpick the object