mxcubecore.HardwareObjects.Beamline

Beamline class serving as singleton container for links to top-level HardwareObjects

All HardwareObjects

Classes

Beamline(name)

Beamline class serving as singleton container for links to HardwareObjects

class mxcubecore.HardwareObjects.Beamline.Beamline(name: str)

Bases: HardwareObject

Beamline class serving as singleton container for links to HardwareObjects

Parameters:

name (str) –

class HOConfig(**kwargs)

Bases: HOConfig

emit(signal: str | object | Any, *args) → None

Emit signal. Accepts both multiple args and a single tuple of args.

This is needed for communication from the GUI to the core (jsonparamsgui in mxcubeqt)

NBNB TODO HACK This is a duplicate of the same function in HardwareObjectMixin. Since the Beamline is not a CommandContainer or a normal HardwareObject it may not be appropriate to make it a subclass of HardwareObjectYaml We need to consider how we want this organised

Parameters:

• signal (Union[str, object, Any]) – In practice a string, or dispatcher.

• *args (tuple) – Arguments sent with signal.

Return type:

None

force_emit_signals()

Emits all hardware object signals

The method is called from the gui via beamline object to ensure that bricks have values after the initialization. Problem arise when a hardware object is used by several bricks. If first brick connects to some signal emitted by a brick then other bricks connecting to the same signal will not receive the values on the startup. The easiest solution is to call force_emit_signals method directly after the initialization of the beamline object

get_default_acquisition_parameters(acquisition_type='default')

Returns:

A AcquisitionParameters object with all default parameters for the specified acquisition type. “default” is a standard acqquisition

get_default_path_template()

Returns:

A PathTemplate object with default parameters.

init()

Object initialisation - executed after loading contents