mxcubecore.HardwareObjects.abstract.AbstractShutter#

AbstractShutter class - interface for shutter type devices. Define open/close methods and is_open property. Overload BaseValueEnum

Classes

AbstractShutter(name)

Abstract base class for shutter type objects.

BaseValueEnum(value)

Defines only the compulsory values.
class mxcubecore.HardwareObjects.abstract.AbstractShutter.AbstractShutter(name)[source]#

Bases: AbstractNState

Abstract base class for shutter type objects.

VALUES#

alias of BaseValueEnum

close(timeout=None)[source]#

Close the shutter. :param timeout: optional - timeout [s],

If timeout == 0: return at once and do not wait if timeout is None: wait forever.

property is_open#

Check if the shutter is open. :returns: True if open, False otherwise. :rtype: (bool)

open(timeout=None)[source]#

Open the shutter. :param timeout: optional - timeout [s],

If timeout == 0: return at once and do not wait if timeout is None: wait forever.

class mxcubecore.HardwareObjects.abstract.AbstractShutter.BaseValueEnum(value)[source]#

Bases: Enum

Defines only the compulsory values.