mxcubecore.HardwareObjects.mockup.ApertureMockup#

Example xml_ configuration:

<object class="ApertureMockup">
  <username>aperture</username>
  <values>{"A5": (5, 0.11), A10": (10, 0.15), "A20": (20, 0.3), "A30": (30, 0.63), "A50": (50, 0.9), "A100": (100, 1)}</values>
  <position_list>["BEAM", "OFF", "PARK"]</position_list>
</object>

Classes

ApertureMockup(name)

Mockup file for aperture as Nstate actuator

class mxcubecore.HardwareObjects.mockup.ApertureMockup.ApertureMockup(name)[source]#

Bases: AbstractNState, ActuatorMockup

Mockup file for aperture as Nstate actuator

get_diameter_size_list()[source]#: Get the list of values to be visible. Hide IN, OUT and UNKNOWN. :returns: List of availble aperture values (string). :rtype: (list)

get_factor(label)[source]#

Get the factor associated to a label. :param (enum: label enum or name :param str): label enum or name

Returns:: Factor value
Return type:: (float) or (tuple)

get_size(label)[source]#

Get the aperture size associated to a label. :param (enum: label enum or name :param str): label enum or name

Returns:: Factor value
Return type:: (float)
Raises:: RuntimeError – Unknown aperture size.

get_value()[source]#: Read the actuator position. :returns: Actuator position. :rtype: value

init()[source]#: Initilise the predefined values