mxcubecore.HardwareObjects.abstract.sample_changer.Component#

Classes

Component(container, address, scannable)

Entity class representing any a sample or sample container

class mxcubecore.HardwareObjects.abstract.sample_changer.Component.Component(container, address, scannable)[source]#

Bases: object

Entity class representing any a sample or sample container

clear_info()[source]#: Clears all sample info (also in components if object is a container)

get_address()[source]#: Returns a unique identifier of the slot of the element () Can never be None - even if the component is not present :rtype: str

get_container()[source]#: Returns the parent of this element :rtype: Container

get_id()[source]#: Returns a unique ID of an element - typically scanned from the real object Can be None if sample is unknown or not present :rtype: str

get_index()[source]#: Returns the index of the object within the parent’s component list, :rtype: int

get_siblings()[source]#: Returns the parent of this element :rtype: Container

is_present()[source]#: Returns true if the element is known to be currently present :rtype: bool

is_scannable()[source]#: Returns if the element can be scanned for ID :rtype: bool

is_scanned()[source]#: Returns if the element has been scanned for ID (for scannable components) :rtype: bool

is_selected()[source]#: Returns if the element is currently selected :rtype: bool