mxcubecore.HardwareObjects.EMBLFlexHCD#

FlexHCD Linux Java implementation of sample changer. Example xml file: <object class = “EMBLFlexHCD”>

<username>Sample Changer</username> <exporter_address>lid231flex1:9001</exporter_address> <object role=”controller” href=”/bliss”/> <puck_configuration>[“SC3”, “UNI”, “SC3”, “UNI”, “UNI”, “UNI”, “UNI”, “UNI”]<

/puck_configuration> </object>

Classes

Basket(container, cell_no, basket_no[, unipuck])

Cell(container, number[, puck_type])

EMBLFlexHCD(*args, **kwargs)

Pin(basket, cell_no, basket_no, sample_no)

class mxcubecore.HardwareObjects.EMBLFlexHCD.Basket(container, cell_no, basket_no, unipuck=False)[source]#

Bases: Container

clear_info()[source]#

Clears all sample info (also in components if object is a container)

class mxcubecore.HardwareObjects.EMBLFlexHCD.Cell(container, number, puck_type='SC3')[source]#

Bases: Container

clear_info()[source]#

Clears all sample info (also in components if object is a container)

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

Bases: SampleChanger

chained_load(old_sample, sample)[source]#

Chain the unload of a sample with a load.

Parameters:

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

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

  • (Object) – Value returned by _execute_task either a Task or result of the operation

get_loaded_sample()[source]#
Returns:

(Sample) Currently loaded sample

get_sample_list()[source]#

Returns the list of all Sample objects under of this container (recursively) :rtype: list

get_sample_properties()[source]#
Returns:

With sample properties defined in Sample

Return type:

(tuple)

init()[source]#

HardwareObject init method

load(**kwargs)#

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(**kwargs)#

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)

class mxcubecore.HardwareObjects.EMBLFlexHCD.Pin(basket, cell_no, basket_no, sample_no)[source]#

Bases: Sample