mxcubecore.HardwareObjects.abstract.AbstractNState

AbstractNState class - interface for N state devices. Defines BaseValueEnum, initialise_values and value_to_enum methds. Implements validate_value, set/update limits.

Classes

AbstractNState(name)	Abstract base class for N state objects.
BaseValueEnum(value)	Defines only the compulsory unknown.

class mxcubecore.HardwareObjects.abstract.AbstractNState.AbstractNState(name)

Bases: AbstractActuator

Abstract base class for N state objects.

VALUES

alias of BaseValueEnum

init()

Initilise the predefined values

initialise_values()

Initialise the ValueEnum with the values from the config.

re_emit_values()

Update values for all internal attributes

set_limits(limits)

Set the low and high limits. :param limits: two element (low limit, high limit) tuple. :type limits: tuple

Raises:

NotImplementedError –

update_limits(limits=None)

Check if the limits have changed. :param limits: two elements (low limit, high limit) tuple. :type limits: tuple

Raises:

NotImplementedError –

validate_value(value)

Check if the value is one of the predefined values. :param value: value to check :type value: Enum

Returns:

True if within the values.

Return type:

(bool)

value_to_enum(value, idx=0)

Tranform a value to Enum :param value: value :type value: str, int, float, tuple :param idx: Index in the value, if tuple :type idx: int

Returns:

Enum member, corresponding to the value or UNKNOWN.

Return type:

(Enum)

class mxcubecore.HardwareObjects.abstract.AbstractNState.BaseValueEnum(value)

Bases: Enum

Defines only the compulsory unknown.