mxcubecore.HardwareObjects.mockup.SampleChangerMockup#

Classes

SampleChangerMockup(*args, **kwargs)

class mxcubecore.HardwareObjects.mockup.SampleChangerMockup.SampleChangerMockup(*args, **kwargs)[source]#

Bases: SampleChanger

get_loaded_sample()[source]#
Returns:

(Sample) Currently loaded sample

init()[source]#

HardwareObject init method

is_mounted_sample(sample)[source]#

Check if the sample is mounted. :param sample_location: Sample location to check.

Returns:

True if mounted.

Return type:

(bool)

load(sample, wait=False)[source]#

Load a sample.

Parameters:
  • sample (tuple) – sample address on the form (component1, … ,component_N-1, component_N)

  • wait (boolean) – True to wait for load to complete False otherwise

Returns
(Object): Value returned by _execute_task either a Task or result of the

operation

unload(sample_slot=None, wait=None)[source]#

Unload sample to location sample_slot, unloads to the same slot as it was loaded from if None is passed

Parameters:
  • sample_slot (tuple) – sample address on the form (component1, … ,component_N-1, component_N)

  • wait – If True wait for unload to finish otherwise return immediately

Returns:

Value returned by _execute_task either a Task or result of the

operation

Return type:

(Object)